在Linux环境下部署Swagger主要有两种方式:使用Docker容器和手动安装。以下是详细的步骤:
使用Docker容器部署
-
安装Docker: 如果你还没有安装Docker,请先安装它。可以参考Docker官方文档进行安装。
-
拉取Swagger Editor和Swagger UI镜像:
docker pull swaggerapi/swagger-editor:v4.6.0 docker pull swaggerapi/swagger-ui:v4.15.5
-
运行Swagger Editor容器:
docker run -d -p 38080:8080 swaggerapi/swagger-editor:v4.6.0
这将把Swagger Editor容器运行在宿主机的38080端口上。
-
运行Swagger UI容器:
docker run -d -p 38081:8080 swaggerapi/swagger-ui:v4.15.5
这将把Swagger UI容器运行在宿主机的38081端口上。
-
访问Swagger Editor和Swagger UI:
- Swagger Editor: http://localhost:38080
- Swagger UI: http://localhost:38081
手动安装
-
安装Node.js和npm:
wget https://nodejs.org/dist/v14.17.0/node-v14.17.0-linux-x64.tar.xz tar -xvf node-v14.17.0-linux-x64.tar.xz cd node-v14.17.0-linux-x64 sudo ln -s /node-v14.17.0-linux-x64/bin/node /usr/local/bin/node sudo ln -s /node-v14.17.0-linux-x64/bin/npm /usr/local/bin/npm
-
安装Express和其他必要的模块:
npm install express body-parser cookie-parser multer
-
下载并解压Swagger UI:
git clone https://github.com/swagger-api/swagger-ui.git cd swagger-ui npm install
-
配置和启动Swagger UI:
- 创建一个
index.js
文件:var express = require('express'); var app = express(); app.use('/swagger', express.static('dist')); app.get('/', function (req, res) { res.send('Hello World'); }); app.listen(3000, function () { var host = server.address().address; var port = server.address().port; console.log("应用实例,访问地址为 http://%s:%s", host, port); });
- 启动服务器:
node index.js
- 创建一个
-
访问Swagger UI: 打开浏览器,访问
http://your_server_ip:3000/swagger
,即可看到Swagger UI界面。
希望这些步骤能帮助你在Linux环境下成功部署Swagger。如果有任何问题,请参考相关的官方文档或寻求社区帮助。