在Linux环境下实现Swagger的自动化部署,可以通过以下几种方法:
使用Docker容器部署(推荐)
-
安装Docker:
sudo apt-get update sudo apt-get install -y docker.io sudo systemctl start docker sudo systemctl enable docker -
拉取Swagger UI和Swagger Editor镜像:
docker pull swaggerapi/swagger-ui:latest docker pull swaggerapi/swagger-editor:latest -
运行容器:
docker run -d -p 8080:8080 swaggerapi/swagger-ui:latest docker run -d -p 8081:8080 swaggerapi/swagger-editor:latest -
访问Swagger UI和Swagger Editor:
- Swagger UI: http://your-server-ip:8080
- Swagger Editor: http://your-server-ip:8081
使用npm安装(适用于需要更精细控制的情况)
-
安装Node.js和npm:
curl -sL https://deb.nodesource.com/setup_16.x | sudo -E bash - sudo apt-get install -y nodejs -
安装依赖:
npm install -g express http-server -
安装Swagger UI和Swagger Editor:
git clone https://github.com/swagger-api/swagger-ui.git cd swagger-ui npm install http-server -p 8080 git clone https://github.com/swagger-api/swagger-editor.git cd swagger-editor npm install http-server -p 8081 -
访问Swagger UI和Swagger Editor:
- Swagger UI: http://your-server-ip:8080
- Swagger Editor: http://your-server-ip:8081
Spring Boot集成Swagger(适用于Spring Boot项目)
-
添加依赖:
在pom.xml文件中添加以下依赖:<dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> <version>2.1.0</version> </dependency> -
启动应用:
启动你的Spring Boot应用,访问 http://your-server-ip:8080/swagger-ui/index.html 查看Swagger文档。
通过以上方法,您可以在Linux环境下轻松配置Swagger,方便API文档的管理和测试。