openapi - 如何在OpenAPI 3.0中全局设置Accept header ？

我通过SwaggerHub进行了新的OpenAPI设置。是否可以选择在全局范围内强制使用某个Accept header ？

我已经在响应中设置了Content-Type:

openapi: 3.0.0

paths:
  /test-path:
     get:
       responses:
         '200':
           description: OK
           content:
             application/vnd.company.v1.0.0+json:

通过cURL请求插入不同的Accept header 时，将执行以下操作:

{"message":"Missing matching response for specified Accept header"}

这是有道理的，因为我们没有为此提供任何回应。

最佳答案

与具有global consumes and produces 的OpenAPI/Swagger 2.0不同，OpenAPI 3.0要求在每个操作中分别定义请求和响应媒体类型。无法全局定义Content-Type或请求或响应。

但是，您可以使用$ref通用响应定义(例如错误响应)，这样可以减少重复。

openapi: 3.0.2
...

paths:
  /foo:
    get:
      responses:
        '400':
          $ref: '#/components/responses/ErrorResponse'
  /bar:
    get:
      responses:
        '400':
          $ref: '#/components/responses/ErrorResponse'


components:
  responses:
    ErrorResponse:
      description: An error occurred
      content:
        application/vnd.error+json:
          schema:
            ...