如何在 swagger 中为 .net 核心 api 方法制作非强制性参数

Question

我注意到，虽然我在代码中设置了[HttpGet（｛id？｝）]，但我的招摇过市索引页面呈现了一个必填字段id

以下是整个方法：

/// <summary>
///  Returns all projects
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
[ProducesResponseType(StatusCodes.Status500InternalServerError)]
[ProducesDefaultResponseType]
[HttpGet("{id?}")]
public async Task<IActionResult> Get([FromRoute] int? id)
{
    return Ok(await Mediator.Send(new GetProjectsQuery { Id = id }));
}

我哪里出错了？




Answer 1

试试这个。从您的HttpVerb中删除id？，从方法签名中删除FromRoute。

/// <summary>
///  Returns all projects
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
[ProducesResponseType(StatusCodes.Status500InternalServerError)]
[ProducesDefaultResponseType]
[HttpGet]
public async Task<IActionResult> Get(int? id)
{
    return Ok(await Mediator.Send(new GetProjectsQuery { Id = id }));
}