温馨提示×

Swagger于Linux怎样集成

小樊
56
2025-09-12 06:36:06
栏目: 智能运维

Swagger在Linux系统集成主要有以下两种常见方式:

一、基于Java框架(如Spring Boot)集成

  1. 安装Java环境

    sudo apt update && sudo apt install openjdk-11-jdk  # Debian/Ubuntu  
    sudo yum install java-11-openjdk-devel              # CentOS/RHEL  
    
  2. 配置构建工具依赖

    • 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>  
      
    • Gradle(build.gradle):
      implementation 'io.springfox:springfox-swagger2:2.9.2'  
      implementation 'io.springfox:springfox-swagger-ui:2.9.2'  
      
  3. 创建Swagger配置类

    @Configuration  
    @EnableSwagger2  
    public class SwaggerConfig {  
        @Bean  
        public Docket api() {  
            return new Docket(DocumentationType.SWAGGER_2)  
                .select()  
                .apis(RequestHandlerSelectors.basePackage("com.example.controller"))  
                .paths(PathSelectors.any())  
                .build();  
        }  
    }  
    
  4. 启动应用并访问
    启动Spring Boot应用后,访问 http://localhost:8080/swagger-ui.html 查看API文档。

二、使用Docker容器部署

  1. 安装Docker

    sudo apt update && sudo apt install docker.io  # Debian/Ubuntu  
    sudo yum install docker                          # CentOS/RHEL  
    sudo systemctl start docker && sudo systemctl enable docker  
    
  2. 拉取并运行Swagger镜像

    • Swagger Editor
      docker pull swaggerapi/swagger-editor:v4.6.0  
      docker run -d -p 38080:8080 swaggerapi/swagger-editor:v4.6.0  
      
    • Swagger UI
      docker pull swaggerapi/swagger-ui:v4.15.5  
      docker run -d -p 38081:8080 swaggerapi/swagger-ui:v4.15.5  
      
  3. 访问Swagger

    • Swagger Editor:http://localhost:38080
    • Swagger UI:http://localhost:38081

三、可选:手动安装(非Docker)

  1. 安装Node.js和npm
    sudo apt update && sudo apt install nodejs npm  
    
  2. 下载Swagger UI
    wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v3.50.0.tar.gz  
    tar -xvf v3.50.0.tar.gz  
    
  3. 配置Web服务器(如Nginx)
    将解压后的文件复制到Web根目录(如 /var/www/html),修改Nginx配置指向该目录并重启服务。

说明

  • Java框架集成适合后端服务,需配合Spring Boot等框架使用;
  • Docker方式轻量便捷,适合快速部署;
  • 手动安装需配置Web服务器,适合定制化场景。

参考来源:

0