nodewpi swagger 配置
时间: 2023-12-09 21:32:15 浏览: 200
Swagger配置及注解.docx
您好!关于 Node.js 中使用 Swagger 的配置,可以按照以下步骤进行:
1. 全局安装 swagger 命令行工具:`npm install -g swagger`
2. 在您的项目目录下创建一个 Swagger API 规范文件(比如 swagger.yaml 或 swagger.json),并编写 API 规范。
3. 在 package.json 文件中添加以下代码,以便在运行您的应用程序时启动 Swagger UI:
```
"scripts": {
"start": "node index.js",
"swagger": "swagger-ui-dist serve -p 3001 swagger.yaml"
}
```
4. 运行 `npm run swagger` 命令以启动 Swagger UI。
5. 访问 `http://localhost:3001`,即可在 Swagger UI 中查看和测试您的 API。
6. 在您的应用程序中使用 swagger-jsdoc 和 swagger-ui-express 中间件来显示 Swagger UI 和将 Swagger 规范绑定到 Express 应用程序。
下面是一个示例代码:
```
const express = require('express');
const swaggerJsdoc = require('swagger-jsdoc');
const swaggerUi = require('swagger-ui-express');
const app = express();
const options = {
definition: {
openapi: '3.0.0',
info: {
title: 'My API',
version: '1.0.0',
},
},
apis: ['./routes/*.js'], // 指定路由文件夹
};
const specs = swaggerJsdoc(options);
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(specs));
app.listen(3000, () => {
console.log('Server started');
});
```
阅读全文