如何将 Headers 信息放在swagger json中

1 回答

• 0

  请求和响应的 Content-Type 标头分别由 consumes 和 produces 关键字定义 . 可以在操作级别或规范的根级别指定它们 .

  Authorization 标头使用 securityDefinitions 和 security 关键字定义 . OpenAPI / Swagger 2.0支持基本身份验证，API密钥和OAuth 2 .

  其他标头可以定义为in: header parameters .

  例如，如果操作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 Types
  Authentication
  Describing Parameters

  回复于 2024-05-02T21:37:59+08:00