c# - Swashbuckle - 返回响应的 Swagger 的文档？

Question

Swashbuckle 不会生成带有“UserCreateResponse”输出的 swagger.json，您如何解决这个问题？

    [HttpPost]
    public async Task<IActionResult> Update([FromBody]UserCreate Request)
    {
        UserCreateResponse response = new UserCreateResponse();

        //do something here

        // returns UserCreateResponse with http status code 200
        return Ok(response);
    }

你不能这样做，因为它不会返回 http 状态代码，200,400,401 等

    [HttpPost]
    public async Task<UserCreateResponse> Update([FromBody]UserCreate Request)
    {
        UserCreateResponse response = new UserCreateResponse();

        //do something here

        // returns UserCreateResponse
        return response;
    }

Answer 1

以下解决方案仅适用于 V6.0 之前的 Swashbuckle 版本!

从 V6.0 开始不再支持 SwaggerResponse，请参阅 here .

---

另一种变体是使用 SwaggerResponse 属性，它还允许提供额外的描述:

[SwaggerResponse(HttpStatusCode.OK, "UserDTO", typeof(UserDTO))]
public async Task<IHttpActionResult> Get([FromODataUri] int key)
{
    var result = await UserRepo.GetAsync(key);
    ...
    return Ok(result);
}

产生如下所示的输出:

也可以省略类型来记录不返回实体的其他状态代码:

[SwaggerResponse(HttpStatusCode.NotFound, "no data found")]
[SwaggerResponse(HttpStatusCode.BadRequest, "requiered request headers not found")]