我要评论
本文介绍在linux系统中部署swagger的步骤。swagger是一个基于java的api文档生成工具，其部署需要java环境以及maven或gradle构建工具。
一、java环境安装
swagger依赖java运行环境。使用openjdk或oracle jdk均可。以下命令以openjdk 11为例：
sudo apt update sudo apt install openjdk-11-jdk
登录后复制
二、maven或gradle配置
使用maven或gradle构建项目时，需在项目配置文件中添加swagger依赖。
2.1 maven (pom.xml):
<dependency>
<groupid>io.springfox</groupid>
<artifactid>springfox-swagger2</artifactid>
<version>2.9.2</version>
</dependency>
<dependency>
<groupid>io.springfox</groupid>
<artifactid>springfox-swagger-ui</artifactid>
<version>2.9.2</version>
</dependency>登录后复制
2.2 gradle (build.gradle):
dependencies {
implementation 'io.springfox:springfox-swagger2:2.9.2'
implementation 'io.springfox:springfox-swagger-ui:2.9.2'
}登录后复制
三、swagger配置
创建一个swagger配置类，启用swagger文档生成。以下示例适用于spring boot和spring mvc框架：
import springfox.documentation.builders.pathselectors;
import springfox.documentation.builders.requesthandlerselectors;
import springfox.documentation.spi.documentationtype;
import springfox.documentation.spring.web.plugins.docket;
import springfox.documentation.swagger2.annotations.enableswagger2;
@configuration
@enableswagger2
public class swaggerconfig {
@bean
public docket api() {
return new docket(documentationtype.swagger_2)
.select()
.apis(requesthandlerselectors.any())
.paths(pathselectors.any())
.build();
}
}登录后复制
四、应用启动与访问
启动spring boot或spring mvc应用。swagger将自动生成api文档。默认情况下，可在浏览器访问http://localhost:8080/swagger-ui.html (端口号根据实际情况调整)查看api文档。
五、端口访问问题解决
如果遇到端口访问问题，可修改启动命令，例如使用java -jar命令启动时，添加参数允许外部访问：
java -jar -dserver.address=0.0.0.0 your-application.jar
登录后复制
六、swagger editor使用(可选)
swagger editor允许在线编辑和测试api文档。您可以自行搭建或使用在线版本。
6.1 自行搭建swagger editor (示例，版本可能需要调整):
- 下载并解压swagger editor：
cd /home/user wget https://github.com/swagger-api/swagger-editor/archive/refs/tags/v3.7.0.tar.gz tar -zxvf swagger-editor-3.7.0.tar.gz mv swagger-editor-3.7.0 swagger-editor
登录后复制
- 安装httpserver并配置环境变量：
sudo npm install -g http-server export path=$path:/home/user/swagger-editor/node_modules/http-server/bin
登录后复制
- 运行swagger editor：
cd swagger-editor http-server -p 8080
登录后复制
- 访问http://your-server-ip:8080 使用swagger editor。
以上步骤完成swagger在linux系统上的部署。 根据实际项目情况，可能需要进行相应调整。
以上就是swagger在linux系统中的部署流程是怎样的的详细内容，更多请关注代码网其它相关文章！
发表评论