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

Question

假设我有一个像 limit 这样的参数。这个被到处使用，如果我需要更新它，就必须到处更改它，这是一件痛苦的事情:

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

我可以使用 $ref 在其他地方定义它并使其可重用吗？我遇到了this ticket这表明有人想要更改或改进功能，但我无法判断它今天是否已经存在？

Answer 1

此功能已存在于 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