Nodejs Swagger 無法向請求添加授權標頭

Question

我正在嘗試使用 Node.js Express 服務器向 Swagger UI 添加授權標頭。 請求需要將x-auth-token作為 API 的標頭之一才能獲得身份驗證。 下面是我的app.js代碼：

const swaggerDefinition = {
  info: {
    title: 'MySQL Registration Swagger API',
    version: '1.0.0',
    description: 'Endpoints to test the user registration routes',
  },
  host: 'localhost:8000',
  basePath: '/api/v1',
  securityDefinitions: {
    bearerAuth: {
      type: 'apiKey',
      name: 'x-auth-token',
      scheme: 'bearer',
      in: 'header',
    },
  },
};

const options = {
  // import swaggerDefinitions
  swaggerDefinition,
  // path to the API docs
  apis: ['dist-server/docs/*.yaml'],
};
// initialize swagger-jsdoc
const swaggerSpec = swaggerJSDoc(options);


// use swagger-Ui-express for your app documentation endpoint
app.use('/docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));

但這並不是將標頭添加到 Swagger UI 中的請求中。 如何解決這個問題？

Answer 1

將以下鍵添加到您的swaggerDefinition ：

  security: [ { bearerAuth: [] } ],

Answer 2

如果您在 swagger 文件中使用 Node 和 Express js，例如在 swagger.json 中添加這樣的授權標頭

    "securityDefinitions": {
    "AuthToken": {
      "type": "apiKey",
      "name": "auth-token",
      "in": "header",
      "description": "The token for authentication"
    }
  },
"security": [
    {
      "AuthToken": []
    }
  ],

注意：安全屬性在 securityDefinitions 對象之外。

請投票此答案以幫助他人

Answer 3

這將在 ExpressJS 應用程序中為您提供幫助。

add this into swagger.json file

"basePath": "/",
"securityDefinitions": {
    "Authorization": {
    "type": "apiKey",
    "name": "authorization",
    "in": "header",
    "description": "Authentication token"
  }
},

add this line into "paths", which API you want to use the token.

"security": [
  {
     "Authorization": []
  }
]