如何定义将应用于所有路径的全局参数

Question

我想制作＆＃34;帐户＆＃34;要应用于所有路径的参数，没有任何异常。是否有任何方法可以使用Swagger 2（我不想为每条路径应用＆＃34;帐户＆＃34;参数）？

{
  "swagger": "2.0",
  "info": {
    "version": "1.0",
    "title": "Doc"
  },
  "host": "localhost",
  "schemes": [
    "http"
  ],
  "produces": [
    "application/json"
  ],
  "parameters": {
    "account": {
      "in": "header",
      "name": "X-ACCOUNT",
      "description": "Account id",
      "type": "string",
      "required": true
    }
  },
  "paths": {
    "/account": {
      "get": {
        "summary": "Get account",
        "operationId": "getAccount",
        "responses": {
          "200": {
            "description": "test"
          }
        }
      }
    },
    ..... other paths
  }
}

Answer 1

这取决于它们是什么类型的参数。

下面的示例在YAML中（为了便于阅读），但您可以使用http://www.json2yaml.com将它们转换为JSON。

与安全相关的参数：授权标头，API密钥等

用于身份验证和授权的参数（例如Authorization标头，API key，API密钥对等应该定义为安全方案而不是参数。

在您的示例中，X-ACCOUNT看起来像API密钥，因此您可以使用：

swagger: "2.0"
...

securityDefinitions:
  accountId:
    type: apiKey
    in: header
    name: X-ACCOUNT
    description: All requests must include the `X-ACCOUNT` header containing your account ID.

# Apply the "X-ACCOUNT" header globally to all paths and operations
security:
  - accountId: []

工具可以以不同于通用参数的方式处理安全方案参数。例如，Swagger UI不会在操作参数中列出API密钥;相反，它会显示＆＃34;授权＆＃34;用户可以在其中输入API密钥的按钮。

通用参数：偏移量，限制，资源ID等

OpenAPI 2.0和3.0没有全局参数的概念。现有的功能要求：
Allow for responses and parameters shared across all endpoints
Group multiple parameter definitions for better maintainability

您可以做的最多是在全局parameters部分（在OpenAPI 2.0中）或components/parameters部分（在OpenAPI 3.0中）中定义这些参数，然后在$ref中明确指出所有参数每次操作。缺点是您需要在每个操作中复制$ref。

swagger: "2.0"
...

paths:
  /users:
    get:
      parameters:
        - $ref: '#/parameters/offset'
        - $ref: '#/parameters/limit'
      ...
  /organizations:
    get:
      parameters:
        - $ref: '#/parameters/offset'
        - $ref: '#/parameters/limit'
      ...

parameters:
  offset:
    in: query
    name: offset
    type: integer
    minimum: 0
  limit:
    in: query
    name: limit
    type: integer
    minimum: 1
    maximum: 50

为了减少代码重复，可以在路径级而不是内部操作中定义适用于路径上所有操作的参数。

paths:
  /foo:
    # These parameters apply to both GET and POST
    parameters:
      - $ref: '#/parameters/some_param'
      - $ref: '#/parameters/another_param'

    get:
      ...
    post:
      ...