Swagger/OpenAPI 3.0 问题及响应示例

Iac*_*ace 6 swagger swagger-ui swagger-editor openapi

这是我在 Swagger 编辑器在线查看的 OpenAPI 3.0 定义的简化版本。我试图获得错误代码 401 和 403 的两个响应,它们共享相同的架构,显示不同的示例 - 这似乎不起作用,我仍然看到引用的类型作为示例。

您能帮我找出这些定义有什么问题吗?

openapi: 3.0.0
info:
  version: '1.0'
  title: A service
paths:
  /doSomething:
    post:
      requestBody:
        content:
          application/json:
            schema:
              type: string
              example: A string
      responses:
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Denied'
components:
  responses:
    Unauthorized:
      description: The endpoint cannot be reached because the request is not authorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: unauthorized
    Denied:
      description: The request's authorizations don't match the required ones needed to access the resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: permissions denied
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
Run Code Online (Sandbox Code Playgroud)

Hel*_*len 2

您的定义是正确的,响应example显示在 Swagger Editor 3.6.5+ 和 Swagger UI 3.17.4+ 中。此外,examplesSwagger UI 3.23.0+ 和 Editor 3.6.31+ 还支持多个。