是否可以定义可重用的路径操作?

时间:2016-01-20 22:22:28

标签: swagger swagger-2.0 aws-api-gateway

我们正在为Swagger API添加CORS支持,其中包括为每个路径定义选项操作。由于这是样板代码,我们想在定义部分中定义一次选项操作,如此

"definitions":{  
 "CORS":{ .. }
 }

然后在我们的路径中引用操作,如此

"paths":{  
      "/system/info":{  
        "options" : {
           "$ref": "#/definitions/CORS"
       }
    }
}

当我们上传swagger定义时,这似乎不起作用。实现我们定义路径操作一次然后跨路径重新使用它的目标的正确方法是什么?

1 个答案:

答案 0 :(得分:3)

您可以引用外部位置的整个路径:

"paths": {
  "/system/info": {
    "$ref": "cors.json"
  }
}

但不是单独的http方法。此外,规范不允许对路径进行相对引用 - 您必须将其放在单独的文档中。

有关路径项对象的信息,请参阅here;有关顶级招摇对象的信息,请参阅here

相关问题