如何使用Swashbuckle.AspNetCore隐藏响应代码200？

Question

再见,

我正在开发一个asp.net web api核心(目标框架.NET Core 2.1).我正在使用Swagger规范记录我的API.我选择使用Swashbuckle.AspNetCore库.

我有一个简单的创建操作,如下所示:

    /// <summary>
    /// My summary
    /// </summary>
    /// <remarks>My remarks</remarks>
    /// <param name="value">value</param>
    /// <response code="201">Created</response>
    /// <response code="400">Data not valid</response>
    /// <response code="500">Internal Server Error</response>
    [HttpPost]
    public IActionResult Post([FromBody, BindRequired] EntityDto value)
    {
       ...
    }

问题是我生成的swagger.json自动创建了"200响应".但因为我的动作只创建实体,所以它只返回201响应.这是以下json片段:

{
  ...
  "responses": {
    "200": {
      "description": "Success"
    },
    "201": {
      "description": "Created"
    },
    "400": {
      "description": "Data not valid"
    },
    "500": {
      "description": "Internal Server Error"
    }
  }
  ...
}

在互联网上冲浪我发现SwaggerResponseRemoveDefaults属性,但似乎只在Full Framework项目中支持.

如何删除200响应？

Answer 1

为了不将默认响应代码包含在 swagger 中，您可以声明可能的返回代码

    /// <summary>
    /// My summary
    /// </summary>
    /// <remarks>My remarks</remarks>
    /// <param name="value">value</param>
    /// <returns>A newly created TodoItem</returns>
    /// <response code="201">Created</response>
    /// <response code="400">Data not valid</response>
    /// <response code="500">Internal Server Error</response>
    [HttpPost]
    [ProducesResponseType(201)]
    [ProducesResponseType(400)]
    [ProducesResponseType(500)]
    public void Post([FromBody] string value)
    {
    }