溫馨提示×

Linux系統中Swagger與Docker結合使用案例

小樊
50
2025-06-12 19:49:42
欄目: 智能運維

在Linux系統中,Swagger與Docker結合使用可以幫助開發者自動化生成API文檔并進行測試。以下是一個簡單的使用案例:

  1. 安裝Docker和Docker Compose: 首先,在Linux服務器上安裝Docker和Docker Compose??梢允褂靡韵旅钸M行安裝:

    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
亚洲午夜精品一区二区_中文无码日韩欧免_久久香蕉精品视频_欧美主播一区二区三区美女