c# - Swashbuckle 参数说明

Question

我正在使用 SwaggerResponse 属性来装饰我的 api Controller 操作，这一切工作正常，但是当我查看生成的文档时，参数的描述字段是空的。

是否有基于属性的方法来描述操作参数(而不是 XML 注释)？

Answer 1

有了最新的 Swashbuckle，或者说至少 Swashbuckle.AspNetCore variant 更好我正在使用的 Description field for parameters 现在可以正确显示为输出。

它确实需要满足以下条件:

• XML comments必须使用 Swagger 启用和配置
• 参数应该用 [FromRoute]、[FromQuery]、[FromBody] 或 [FromUri] 明确修饰
• 方法类型相同(get/post/put等)，应该用[Http...]修饰
• 像往常一样用 <param ...> 描述参数xml注释

完整的示例如下所示:

/// <summary>
/// Short, descriptive title of the operation
/// </summary>
/// <remarks>
/// More elaborate description
/// </remarks>
/// <param name="id">Here is the description for ID.</param>
[ProducesResponseType(typeof(Bar), (int)HttpStatusCode.OK)]
[HttpGet, Route("{id}", Name = "GetFoo")]
public async Task<IActionResult> Foo([FromRoute] long id)
{
    var response = new Bar();
    return Ok(response);
}

产生以下输出: