信息发布→ 登录 注册 退出

Swagger在Linux系统中的部署流程是怎样的

发布时间:2025-03-28

点击量:

本文介绍在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):


    io.springfox
    springfox-swagger2
    2.9.2


    io.springfox
    springfox-swagger-ui
    2.9.2

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 (示例,版本可能需要调整):

  1. 下载并解压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
  1. 安装HttpServer并配置环境变量:
sudo npm install -g http-server
export PATH=$PATH:/home/user/swagger-editor/node_modules/http-server/bin
  1. 运行Swagger Editor:
cd swagger-editor
http-server -p 8080
  1. 访问http://your-server-ip:8080 使用Swagger Editor。

以上步骤完成Swagger在Linux系统上的部署。 根据实际项目情况,可能需要进行相应调整。

标签:# xml  # 为例  # 可选  # 实际情况  # 均可  # 可在  # 您可以  # 适用于  # 运行环境  # 是一个  # 文档  # ui  # http  # gradle  # oracle  # mvc框架  # maven  # html  # spring boot  # spring  # mvc  # Java  # spring mvc  # 工具  # 浏览器  # git  # linux  
在线客服
服务热线

服务热线

4008888355

微信咨询
二维码
返回顶部
×二维码

截屏,微信识别二维码

打开微信

微信号已复制,请打开微信添加咨询详情!