Swagger:向所有端点添加字段

时间:2016-06-07 07:03:44

标签: swagger-ui swagger-2.0

有没有办法为我的所有终点添加默认字段? 我希望将api_key,sort,limit等字段添加到我的所有终点。

您可以在中央位置的所有端点添加一组默认输入参数吗?

1 个答案:

答案 0 :(得分:1)

您可以定义像

这样的参数
"parameters": {
"skipParam": {
  "name": "skip",
  "in": "query",
  "description": "number of items to skip",
  "required": true,
  "type": "integer",
  "format": "int32"
},

然后像

一样使用它
 "parameters": [
      { "$ref": "#/parameters/skipParam" }
],

使用此功能,您不必反复指定参数详细信息,但需要在需要时添加ref。

可在Open Api Specification

找到更多详情