Swashbuckle SwaggerResponseRemoveDefaults атрибут все еще добавляет 200 Успешный ответ Swagger - PullRequest
Новая
       84

Swashbuckle SwaggerResponseRemoveDefaults атрибут все еще добавляет 200 Успешный ответ Swagger

1 голос
/ 24 февраля 2020

Я использую Swashbuckle и Swagger UI в проекте. NET Core 3.1, а мои XML комментарии импортированы в Swagger. У меня есть POST-запрос к контроллеру, для которого я хочу зарегистрировать несколько статусов ответов (201, 401, 403, 404) в Swagger. Проблема в том, что я также вижу ответ 200 Success вместе с моими явно указанными ответами кода состояния в файле swagger.json и интерфейсом Swagger UI.

Как предложено в нескольких разных места, где я использую атрибут [SwaggerResponseRemoveDefaults], чтобы попытаться предотвратить это, однако все, что я пытаюсь, все равно приводит к ответу по умолчанию 200.

Я пробовал:

  • добавление атрибута к методу,
  • добавление атрибута в контроллер,
  • добавление атрибута в абстрактный базовый контроллер,

и все комбинации вышеперечисленного , Я также пробовал это в комбинации с:

  • , указывающим желаемые типы ответов с XML <response code="XXX"></response> тегами комментариев, и
  • , указывающими желаемые типы ответов с [SwaggerResponse(XXX)] конечными точками.

Ничто не приводит к удалению 200 Success результата из моего Swagger UI и swagger.json.

TrackerController.cs 

/// <summary>...</summary>
/// <response code="401">User is not authenticated.</response>
/// <response code="404">Tracker not found.</response>
[Authorize]
[ApiController]
[Route("[controller]")]
[SwaggerResponseRemoveDefaults]
public partial class TrackersController : AbstractController
{
    ...

    /// <summary>...</summary>
    /// <param name="tracker">The details of the tracker to be created.</param>
    /// <response code="201">The tracker was successfully created.</response>
    /// <response code="403">User is not authorized to modify this resource.</response>
    [HttpPost]
    [SwaggerResponseRemoveDefaults]
    [ResponseType(typeof(TrackerDto))]
    [SwaggerResponse(201, Description = "The tracker was successfully created.")]
    public async Task<IActionResult> CreateTracker([FromBody] TrackerDto tracker)
    {
        ...
    }

    ...

}

swagger. json

{
  "openapi": "3.0.1",
  "info": {
    "title": "My API",
    "version": "v1"
  },
  "paths": {
    "/Trackers": {
      "post": {
        "tags": [
          "Trackers"
        ],
        "summary": "Create a new tracker.",
        "requestBody": {
          "description": "The details of the tracker to be created.",
          "content": {
            "application/json-patch+json": {
              "schema": {
                "$ref": "#/components/schemas/TrackerDto"
              }
            },
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TrackerDto"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/TrackerDto"
              }
            },
            "application/*+json": {
              "schema": {
                "$ref": "#/components/schemas/TrackerDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success"
          },
          "201": {
            "description": "The tracker was successfully created."
          },
          "401": {
            "description": "User is not authenticated."
          },
          "403": {
            "description": "User is not authorized to modify this resource."
          },
          "404": {
            "description": "Tracker not found."
          }
        }
      }
    }
  }
}

Снимок экрана Swagger UI

1 Ответ

0 голосов
/ 24 февраля 2020

Прямо сейчас вы говорите Swagger, что вы производите TrackerDto с типом по умолчанию 200 и, кроме того, другой ответ 201. Вам нужно сделать этот один единственный соответствующая пара.

Удалите атрибут ResponseType и укажите тип, к которому он относится: 

[SwaggerResponse(201, Description = "The tracker was successfully created.", typeof(TrackerDto))]

Вы также можете попробовать: 

[ProducesResponseType(typeof(TrackerDto), 201)]

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

...