Swagger / OpenAPI-使用$ ref传递可重用的已定义参数

Question 1

假设我有一个类似的参数limit。这个地方到处都是，如果我需要更新它，那么到处都必须更改它是一个痛苦的事情：

parameters:
    - name: limit
      in: query
      description: Limits the number of returned results
      required: false
      type: number
      format: int32

我可以使用$ ref在其他地方定义它并使其可重用吗？我碰到了这张票，暗示有人想更改或改进功能，但是我不知道它是否已经存在？

Question 2

Swagger 2.0中已经存在此功能。链接的票证讨论了它的一些特定机制，但并不影响此功能的功能。

在顶级对象（称为Swagger对象）上，有一个parameters属性，您可以在其中定义可重复使用的参数。您可以给参数指定任何名称，然后从路径/特定操作中引用它。顶级参数仅是定义，并不自动应用于规范中的所有操作。

您可以在此处找到示例-https: //github.com/swagger-api/swagger-spec/blob/master/fixtures/v2.0/json/resources/reusableParameters.json即使具有限制参数。

对于您的情况，您想这样做：

# define a path with parameter reference
/path:
   get:
      parameters:
         - $ref: "#/parameters/limitParam"
         - $ref: "#/parameters/offsetParam"

# define reusable parameters:
parameters:
   limitParam:
      name: limit
      in: query
      description: Limits the number of returned results
      required: false
      type: integer
      format: int32
   offsetParam:
      name: offset
      in: query
      description: Offset from which start returned results
      required: false
      type: integer
      format: int32

Question 3

为了完整起见，这是在OpenAPI（又名swagger v3）中的样子：

openapi: "3.0.0"
servers:
    - url: /v1
      description: local server

paths:
   /path:
      get:
         parameters:
            - $ref: "#/components/parameters/limitParam"

components:
   parameters:
      limitParam:
         name: limit
         in: query
         description: Limits the number of returned results
         required: false
         schema:
            type: integer
            minimum: 10
            default: 10
            multipleOf: 10 # matches 10, 20, ...
            format: int32