温馨提示×

swagger怎样在ubuntu部署

小樊
54
2025-08-07 04:50:46
栏目: 智能运维

Swagger在Ubuntu的部署方式主要有以下几种,可根据需求选择:

1. 使用Docker部署(推荐)

  • 安装Docker
    sudo apt update  
    sudo apt install docker-ce docker-ce-cli containerd.io  
    
  • 创建Dockerfile
    在Swagger项目根目录新建Dockerfile,内容如下:
    FROM node:16  
    WORKDIR /app  
    COPY . .  
    RUN npm install  
    EXPOSE 3000  
    CMD ["npm", "start"]  
    
  • 构建并运行容器
    docker build -t swagger-ui .  
    docker run -d -p 3000:3000 --name swagger-container swagger-ui  
    
  • 访问Swagger UI
    浏览器输入http://localhost:3000即可查看。

2. 直接安装Swagger UI(非Docker)

  • 安装依赖
    sudo apt install nodejs npm  
    
  • 下载并启动
    wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v3.48.0.tar.gz  
    tar -xvf v3.48.0.tar.gz  
    cd swagger-ui-3.48.0  
    npm install  
    npm start  
    
    访问http://localhost:3000查看。

3. 集成到Spring Boot项目(后端API场景)

  • 添加依赖
    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>  
    
  • 配置类
    创建SwaggerConfig.java,启用Swagger并指定文档路径:
    @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应用,访问http://localhost:8080/swagger-ui.html

注意事项

  • 确保系统已安装Node.js(非Docker方式需)和Java(Spring Boot/生成代码需)。
  • 若需修改端口,可在启动命令或配置文件中调整(如-p 8080:8080)。
  • 防火墙需开放对应端口(sudo ufw allow 30008080)。

根据项目类型选择合适方式,Docker适合快速部署,Spring Boot适合后端集成,直接安装适合轻量级测试。

0