Swashbuckle Swagger ResponseRemoveDefaults属性仍向Swagger添加200个成功响应

Question

我在一个...NET Core 3.1项目，将我的XML注释导入到Swagger中。我在一个控制器上有一个POST请求，我想在Swagger中注册一些响应状态（201, 401, 403, 404)。问题是，在swagger.json文件和Swagger UI界面中，我还看到一个200成功响应与我显式指定的状态代码响应并列。

正如在多个不同的地方建议的那样，我正在使用[SwaggerResseRemveDefaults]属性来尝试并防止这种情况，但是我所尝试的一切仍然会导致列出默认的200响应。

我尝试过：

• 将属性添加到方法，
• 将属性添加到控制器，
• 将属性添加到抽象基本控制器，

以及上述各项的所有组合。我还尝试了以下方法：

• 使用XML指定所需的响应类型

没有任何结果会从我的招摇过市UI和Swagger中删除200个成功结果。json。

跟踪控制器。反恐精英

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

    ...

}

大摇大摆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."
          }
        }
      }
    }
  }
}

大摇大摆的用户界面截图




Answer 1

现在，您正在告诉Swagger您正在生成一个默认类型为200的TrackerDto，另外还有一个响应201。你需要做一对匹配的。

删除响应类型属性，并将类型放在它所属的位置：

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

您也可以尝试：

[ProducesResponseType(typeof(TrackerDto), 201)]

重要的是将类型和状态代码放在同一个属性中，以便Swagger知道它们属于同一个属性。