温馨提示×

Linux系统中Swagger与Docker结合使用案例

小樊
54
2025-06-12 19:49:42
栏目: 智能运维

在Linux系统中,Swagger与Docker结合使用可以帮助开发者自动化生成API文档并进行测试。以下是一个简单的使用案例:

  1. 安装Docker和Docker Compose: 首先,在Linux服务器上安装Docker和Docker Compose。可以使用以下命令进行安装:

    sudo apt-get update sudo apt-get install docker.io docker-compose 
  2. 创建Spring Boot项目并集成Swagger: 创建一个Spring Boot项目,并在其中集成Swagger。可以通过添加相关依赖和配置来实现:

    <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> 
  3. 配置Swagger: 在项目中创建一个Swagger配置类,启用Swagger并配置基本信息:

    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.basePackage("com.example.controller")) .paths(PathSelectors.any()) .build() .apiInfo(apiInfo()); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("API 文档") .description("这是 Spring Boot 项目的 API 文档") .version("1.0") .build(); } } 
  4. 创建docker-compose.yml文件: 创建一个docker-compose.yml文件,定义微服务及其相关配置,如镜像、端口映射和环境变量等:

    version: '3' services: api: image: your-spring-boot-app-image ports: - "8080:8080" environment: - SPRING_PROFILES_ACTIVE=prod 
  5. 构建和启动容器: 在包含docker-compose.yml文件的目录中运行以下命令,以构建和启动所有定义的服务:

    docker-compose up -d 
  6. 访问Swagger UI: 启动Spring Boot应用后,可以通过访问http://localhost:8080/swagger-ui.html查看自动生成的API文档,并进行测试。

通过以上步骤,你可以在Linux系统中成功结合使用Swagger和Docker来管理和部署微服务,并自动化生成API文档。

0