Swagger：向所有端点添加字段

Question

有没有办法将默认字段添加到我的所有端点？我希望将 api_key、排序、限制等字段添加到我的所有端点。

能否在一个中心位置为所有端点添加一组默认输入参数？

Answer 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

找到更多详细信息

Swagger：向所有端点添加字段

Swagger: Add fields to all endpoints

swagger-ui

swagger-2.0