如何在swagger json文件中为每个请求添加自定义标头

时间:2018-02-15 09:53:18

标签: swagger postman swagger-ui

我已从其中一个服务中复制swagger.json文件,并希望将其导入Postman集合

然后问题是我想在每个请求的标头中添加自定义API密钥。 我已经阅读了securityDefinitions,但它似乎无法运作

我们说它的名字是myCustomAPIKey,有没有办法可以在 swagger的JSON 文件中手动添加它?

1 个答案:

答案 0 :(得分:0)

正常情况下,就像下面的代码片段一样。您创建af securityDefinition,然后在安全性部分中使用该定义。

{
  "swagger": "2.0",
  "info": {
    "title": "API",
    "version": "1.0"
  },
  "host": "example.com",
  "basePath": "/api",
  "schemes": [
    "http",
    "https"
  ],
  "securityDefinitions": {
    "myCustomAPIKey": {
      "type": "apiKey",
      "name": "myCustomAPIKey",
      "in": "header"
    }
  },
  "security": [
    {
      "myCustomAPIKey": []
    }
  ],
  "paths": {...}
}

此处记录(版本2)https://swagger.io/docs/specification/2-0/authentication/api-keys/