Swagger在Linux下主要有两种部署方式:
一、Docker容器部署(推荐)
- 安装Docker
sudo apt update && sudo apt install docker.io sudo systemctl start docker && sudo systemctl enable docker - 拉取并运行Swagger镜像
- Swagger Editor(在线编辑API文档)
docker pull swaggerapi/swagger-editor:v4.6.0 docker run -d -p 38080:8080 swaggerapi/swagger-editor:v4.6.0 - Swagger UI(查看API文档)
docker pull swaggerapi/swagger-ui:v4.15.5 docker run -d -p 38081:8080 swaggerapi/swagger-ui:v4.15.5
- Swagger Editor(在线编辑API文档)
- 访问服务
- Swagger Editor:
http://服务器IP:38080 - Swagger UI:
http://服务器IP:38081
- Swagger Editor:
二、手动部署(需配置环境)
- 安装Node.js和npm
sudo apt update && sudo apt install nodejs npm - 部署Swagger UI
- 下载并解压:
git clone https://github.com/swagger-api/swagger-ui.git cd swagger-ui && npm install - 配置Web服务器(以Nginx为例):
sudo cp -r swagger-ui/dist/* /var/www/html/ sudo nano /etc/nginx/sites-available/default # 修改root指向/var/www/html,并添加try_files规则 sudo systemctl restart nginx
- 下载并解压:
- 访问Swagger UI
http://服务器IP/swagger-ui(需将解压后的文件放在Web根目录)
三、注意事项
- 若需自定义API文档,需在项目目录中添加
swagger.json或swagger.yaml文件,并在部署时指定路径。 - 确保服务器防火墙开放对应端口(如80、8080)。
以上步骤参考自,可根据实际需求选择部署方式。