在Linux上利用Swagger实现API文档共享,可以按照以下步骤进行:
1. 安装Node.js和npm
首先,需要在Linux服务器上安装Node.js和npm。可以从Node.js官网下载适合Linux的安装包,然后使用以下命令进行安装:
cd /opt 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 sudo mv node-v14.17.0-linux-x64 /usr/local/nodejs export PATH=$PATH:/usr/local/nodejs/bin
验证安装:
node -v npm -v
2. 安装Swagger Editor
接下来,安装Swagger Editor。可以通过以下命令下载并解压:
cd /opt wget https://github.com/swagger-api/swagger-editor/archive/refs/tags/v3.16.1.tar.gz tar -xvf v3.16.1.tar.gz sudo rm v3.16.1.tar.gz
进入解压后的目录并启动Swagger Editor:
cd swagger-editor-3.16.1 npm install nohup http-server -p 8080 &
访问http://your-server-ip:8080即可使用Swagger Editor。
3. 安装Swagger UI
安装Swagger UI的步骤如下:
cd /opt wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v3.48.0.tar.gz tar -xvf v3.48.0.tar.gz sudo rm v3.48.0.tar.gz
初始化npm项目并安装Express:
cd swagger-ui-3.48.0 npm init -y npm install express --save
编辑index.js
文件,配置静态文件服务:
var express = require('express'); var app = express(); app.use('/swagger', express.static('public')); app.get('/', function (req, res) { res.send('Hello World!'); }); app.listen(3000, function () { console.log('Example app listening on port 3000!'); });
将Swagger UI的dist
目录下的文件复制到public
文件夹中,然后启动服务器:
cd public nohup node ../index.js &
访问http://your-server-ip:3000/swagger即可查看Swagger UI文档。
4. 集成Spring Boot项目(可选)
如果使用Spring Boot项目,可以使用springdoc
来生成API文档。首先,在pom.xml
中添加依赖:
org.springdoc springdoc-openapi-starter-webmvc-ui 2.1.0
然后,配置application.properties
文件:
springdoc.api-docs.path=/api-docs springdoc.swagger-ui.path=/swagger-ui
启动Spring Boot应用后,访问http://your-server-ip:8080/swagger-ui即可查看生成的API文档。
通过以上步骤,可以在Linux上成功搭建Swagger环境,实现API文档的共享和管理。