如何在swagger json中放置标头信息

Question

我按照 swagger 文档中的以下链接为我的 rest api 创建了 swagger json。

https://swagger . io/docs/specification/2-0/descripting-request-body/

在我的 rest API 中，我有与服务请求一起的请求正文和 http 标头，如内容类型和授权。

我想知道是否有办法在swagger json中包含请求正文和超文本传输协议标头信息？我在swagger文档中没有看到该信息。

Answer 1

请求和响应的Content-Type头分别由消耗和 keywords定义。它们可以在规范的操作级别或根级别上指定。

Authorization头是使用securityDefinition和 关键字定义的。OpenAPI/Swagger 2.0支持基本身份验证、API密钥和OAuth 2。

其他标头可以定义为：标头参数。

例如，如果一个操作POST JSON并使用Basic auth，您可以如下描述：

swagger: '2.0'
...

securityDefinitions:   # Authorization, part 1
  basicAuth:
    type: basic

paths:
  /something:
    post:
      summary: POST some JSON
      consumes:
        - application/json  # Request Content-Type
      produces:
        - application/json  # Response Content-Type
      security:
        - basicAuth: []     # Authorization, part 2
      parameters:
        - in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/Something'
      responses:
        200:
          description: OK

相关留档：
MIME类型
身份验证
描述参数