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

Question

我正在使用 Swagger for WebApi 5.5.3 nuget 包作为 API 文档。在招摇的 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显示为查询参数，但是当我将其标记为可为空的参数时，它是必需的。

我还尝试使当前PageIndex在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);
}

希望这能解决你的问题。