定义可以通过Swagger由多个路径重用的共享路径参数

时间:2016-07-26 18:20:44

标签: yaml swagger

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

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#)链接的模式,它似乎似乎这应该是无效的,但由于某种原因,这被在线编辑器拒绝。

无论如何共享路径参数定义?

1 个答案:

答案 0 :(得分:2)

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

required: false

Swagger API定义必须包含路径参数。将其更改为true修复了所有问题。这只是模式验证发生的副作用,导致非描述性错误被抛弃。