如何在几乎所有路径中复制粘贴3个通用错误响应?

Cra*_*Man 10 swagger openapi

我希望我的几乎所有路径都有以下3个通用错误响应.我怎么在Swagger中描述它,而不是在任何地方复制这些行?

    401:
      description: The requester is unauthorized.
      schema:
        $ref: '#/definitions/Error'
    500:
      description: "Something went wrong. It's server's fault."
      schema:
        $ref: '#/definitions/Error'
    503:
      description: Server is unavailable. Maybe there is maintenance?
      schema:
        $ref: '#/definitions/Error'
Run Code Online (Sandbox Code Playgroud)

我在请求中如何使用它的示例:

paths:
    /roles:
      get:
        summary: Roles
        description: |
          Returns all roles available for users.
        responses:
          200:
            description: An array with all roles.
            schema:
              type: array
              items:
                $ref: '#/definitions/Role'
          401:
            description: The requester is unauthorized.
            schema:
              $ref: '#/definitions/Error'
          500:
            description: "Something went wrong. It's server's fault."
            schema:
              $ref: '#/definitions/Error'
          503:
            description: Server is unavailable. Maybe there is maintenance?
            schema:
              $ref: '#/definitions/Error'
Run Code Online (Sandbox Code Playgroud)

Cra*_*Man 6

看起来我可以添加以下全局响应定义:

# An object to hold responses that can be used across operations.
# This property does not define global responses for all operations.
responses:
  NotAuthorized:
    description: The requester is unauthorized.
    schema:
      $ref: '#/definitions/Error'
Run Code Online (Sandbox Code Playgroud)

但是我仍然需要在这样的路径中引用它:

401:
  $ref: '#/responses/NotAuthorized'
Run Code Online (Sandbox Code Playgroud)

  • [此要求的公开票](https://github.com/OAI/OpenAPI-Specification/issues/521) (3认同)