如何将api参数标记为Web API 2的Swagger UI的可选参数？

Question

我正在使用Swagger for WebApi 5.5.3 nuget包来获取API文档。在swagger UI中，它显示了可选参数的必需选项。

我在Visual Studio中尝试了XML注释选项。下面是我想要记录的API方法：

/// <summary> 
    /// Gets the history. 
    /// </summary> 
    /// <param name="currentPageIndex">Index of the current page.</param> 
    /// <param name="pageSize">Size of the page.</param> 
    /// <param name="lastSyncDate">The last synchronize date.</param> 
    /// <returns></returns> 
    [HttpGet] 
    [Route("GetHistory/{currentPageIndex}/{pageSize}")] 
    public IHttpActionResult GetHistory(int currentPageIndex, int pageSize, DateTime? lastSyncDate) 
    { 
     var response = _myRepo.GetData(); 
     if (response == null) 
      return BadRequest(Messages.InvalidPageIndex); 

     return Ok(response); 
    } 

是表示lastSyncDate作为查询参数，但同时我也将其标记为可为空参数是必需的。

我也尝试使currentPageIndex在xml中可为空以及路由，但仍显示所需的所有属性。请帮忙。

Answer 1

解决方案如下

给出这个问题创建模型类

using System; 
    using System.ComponentModel.DataAnnotations; 

    public class SearchHistory 
    { 
     [Required] 
     public int CurrentPageIndex { get; set; } 
     [Required] 
     public int PageSize { get; set; } 
     public DateTime? LastSyncDate { get; set; } 
    } 

更改您的输入参数与新创建的模型

[HttpGet] 
public IHttpActionResult GetHistory(SearchHistory modle) 
{ 
    var response = _myRepo.GetData(); 
    if (response == null) 
     return BadRequest(Messages.InvalidPageIndex); 

    return Ok(response); 
} 

希望这将解决您的问题。