使用 Swagger 定义多个路径可以重用的共享路径参数答案

【问题标题】：Define shared path parameter that can be re-used by multiple paths with Swagger使用 Swagger 定义多个路径可以重用的共享路径参数
【发布时间】：2016-07-26 18:20:43
【问题描述】：

我有一系列使用相同路径参数的路径：

paths:
  /catalog/items/{id}:
    ...
  /catalog/items/{id}/children:
    ...
  etc.

我希望使用描述和类型定义一次 {id} 参数，以便我可以重复使用它，但这似乎无效：

paths:
   ...
parameters:
  catalogItemId: # <-- Not a valid parameter definition
    name: id
    in: path 
    description: The ID of the catalog item to update.
    required: false
    type: integer
    format: int64

似乎根据编辑器链接的架构（http://swagger.io/v2/schema.json#），这应该是无效的，但由于某种原因，这被在线编辑器拒绝了。

是否有共享路径参数定义？

【问题讨论】：

标签： yaml swagger

【解决方案1】：

发布后不久，我意识到路径参数被列为

required: false

路径参数必须是 Swagger API 定义所必需的。将其更改为 true 可以解决所有问题。这只是模式验证发生方式的副作用，会导致非描述性错误被丢弃。

【讨论】：