Swagger在Ubuntu上的部署流程可根据使用场景选择以下方式:
安装Docker
sudo apt update
sudo apt install docker.io
sudo systemctl start docker
sudo systemctl enable docker
创建Dockerfile
在项目根目录新建Dockerfile
,内容如下:
FROM node:14
WORKDIR /app
COPY . .
RUN npm install
EXPOSE 3000
CMD ["npm", "start"]
构建并运行容器
docker build -t swagger-ui .
docker run -d -p 3000:3000 --name swagger-container swagger-ui
访问Swagger UI
浏览器输入http://localhost:3000
即可查看。
安装依赖
sudo apt install nodejs npm
npm install -g swagger-ui-express swagger-jsdoc
配置项目
swagger.json
或swagger.yaml
定义API文档。const express = require('express');
const swaggerUi = require('swagger-ui-express');
const swaggerDocument = require('./swagger.json');
const app = express();
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
app.listen(3000, () => console.log('Server running on port 3000'));
启动服务
node app.js
访问http://localhost:3000/api-docs
查看文档。
安装Nginx
sudo apt install nginx
配置代理
编辑/etc/nginx/sites-available/default
,添加:
location /swagger/ {
proxy_pass http://localhost:3000/;
proxy_set_header Host $host;
}
重启Nginx
sudo systemctl restart nginx
之后可通过http://your-server-ip/swagger/
访问。
swagger-jsdoc
从代码注释自动生成swagger.json
。根据实际需求选择部署方式,Docker适合快速部署,Node.js适合集成到现有后端服务。