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

Question

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

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

对于令牌部分，我需要通过以下方式记录它：

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

但是我如何记录这一点以进行身份​​验证，我需要提供Accept: application/json; version=public/v2. 标Accept头必须包含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`)