openapi - 在 OpenAPI 3 中，如何记录请求时需要具有指定值的 Accept header 才能成功调用 API？

Question

对于我记录的旧 API 以便成功进行身份验证，我需要提供以下 header :

X-Access-Token: {token}
Accept: application/json; version=public/v2

对于 token 部分，我需要通过以下方式记录它:

openapi: 3.0.0
info:
  version: "v2"
  title: Company App Public Api
  description: Integrate your platform with company app website

components:
  securitySchemes:
    ApiKey:
      type: 'apiKey'
      in: 'header'
      name: 'X-Access-Token'
security:
  - ApiKey: []  

但是我如何记录这也用于身份验证我需要提供 Accept: application/json; version=public/v2 . Accept header 必须包含 application/json; version=public/v2其他任何返回 406 Not Acceptable标题。
此外，标题 Accept带值 application/json; version=public/v2应该在我的要求中。响应头总是 application/json .
你知道我如何记录吗？

Answer 1

在 OpenAPI 3.0 中，请求头 Accept和响应头 Content-Type都定义为 responses.<code>.content.<Accept value> .这需要在每个操作中定义。

paths:
  /something:
    get:
      responses:
        '200':
          description: Successful operation
          content:
            'application/json; version=public/v2':  # <-----
              schema:
                ...
         '406':
           description: Invalid media type was specified in the `Accept` header (should be `application/json; version=public/v2`)