Open API规范中的可重用参数

时间:2020-03-27 11:51:45

标签: swagger-2.0 openapi

我有一个接受X-Request-ID标头的端点。描述为:

parameters:
    - in: header
      name: X-Request-ID
      schema:
        type: string
        format: uuid
      required: true

但是,如果我有十个使用此标头的端点,我是否必须继续重复此操作,还是有可以重用的地方?

谢谢

1 个答案:

答案 0 :(得分:1)

要添加到海伦的评论中,您可以通过在Parameter Object中将X-Request-ID定义为Parameters Definitions Object,然后在其中引用(通过使用Reference Object)来实现一些重用。每个Path Item Objectparameters字段表示它适用于该路径下的所有操作。