Как я могу скрыть код ответа 200 с помощью Swashbuckle.AspNetCore?

Question

Ciao,

Я работаю над ядром веб-API asp.net (целевая среда .NET Core 2.1).Я документирую свой API, используя спецификации Swagger.Я решил использовать библиотеку 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

Чтобы не включать код ответа по умолчанию в сваггер, вы можете объявить возможные коды возврата

    /// <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)
    {
    }