微服務架構下使用Spring Cloud Zuul作為網關將多個微服務整合到一個Swagger服務上

注意：

　　如果你正在研究微服務，那必然少不了服務之間的相互調用，哪么服務之間的接口以及api就必須生成系統的管理文檔了。如果你希望更好的管理你的API，你希望有一個工具能一站式地解決API相關的所有事情，那么，swagger將是一個不錯的選擇,以下就為大家介紹swagger是使用方法，如有不對之處，還望指正！

1、項目結構

　　springBoot-user-zuul-swagger   —　zuul網關　端口   9501

　　 ls-prevention-check　　　　　  —   服務1         端口   8091 

　　microcloud-provider-company     —   服務2         端口　8105

2、實現放法

　　一、添加依賴

　　分別在三個服務中添加Swagger需要依賴兩個jar包，在pom.xml中添加如下坐標

 

    <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
    </dependency>
    <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
    </dependency>

 

 

　　二、創建配置類

　　　　分別在服務提供者項目中加入Swagger一個配置類來進行對swagger的基本配置，

 

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.zyc.controller"))
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Hello系統api")
                .description("Hello系統接口文檔說明")
                .contact(new Contact("vker", "", "[e-mail]"))
                .version("1.0")
                .build();
    }

    @Bean
    UiConfiguration uiConfig() {
        return new UiConfiguration(null, "list", "alpha", "schema",
                UiConfiguration.Constants.DEFAULT_SUBMIT_METHODS, false, true, 60000L);
    }
}

 

 

 　　三、啟動類加注解

　　　　@EnableSwagger2

　　四、在需要生成的類或方法上加具體注解

　　　　

@Api("Hello接口")
@RestController
@RequestMapping("/company")
public class Hello {
    
    @ApiOperation(value="/get/hello方法")
    @GetMapping("/get/hello")
    public String hello() {
        return "Hello Zuul springBoot-microcloud-provider-company";
    }
    
}

 

　　注意：這里只是一個小栗子：詳細注解含義如下：

@Api() 用於類；表示標識這個類是swagger的資源 
tags–表示說明 
value–也是說明，可以使用tags替代 

@ApiOperation() 用於方法；表示一個http請求的操作 
value用於方法描述 
notes用於提示內容 


@ApiParam() 用於方法，參數，字段說明；表示對參數的添加元數據（說明或是否必填等） 
name–參數名 
value–參數說明 
required–是否必填

@ApiModel()用於類 ；表示對類進行說明，用於參數用實體類接收 
value–表示對象名 

@ApiModelProperty()用於方法，字段； 表示對model屬性的說明或者數據操作更改 
value–字段說明 
name–重寫屬性名字 
dataType–重寫屬性類型 
required–是否必填 
example–舉例說明 
hidden–隱藏

@ApiImplicitParam() 用於方法 
表示單獨的請求參數

@ApiImplicitParams() 用於方法，包含多個 @ApiImplicitParam 
name–參數ming 
value–參數說明 
dataType–數據類型 
paramType–參數類型 
example–舉例說明

@ApiIgnore
作用於方法上，使用這個注解swagger將忽略這個接口

 

 

　　五、重點：在springBoot-user-zuul-swagger項目中添加文檔資源配置類DocumentationConfig

　　　　　　　注意：springBoot-user-zuul-swagger必須集成Zuul作為路由訪問

 

@Component
@Primary
public class DocumentationConfig implements SwaggerResourcesProvider{

    @Override
    public List<SwaggerResource> get() {
         List resources = new ArrayList<>();
            resources.add(swaggerResource("Hello接口", "/study-proxy/company-proxy/v2/api-docs", "1.0"));
            resources.add(swaggerResource("檢查系統接口", "/study-proxy/prevention-check/v2/api-docs", "1.0"));
            return resources;
    }

     private SwaggerResource swaggerResource(String name, String location, String version) {
            SwaggerResource swaggerResource = new SwaggerResource();
            swaggerResource.setName(name);
            swaggerResource.setLocation(location);
            swaggerResource.setSwaggerVersion(version);
            return swaggerResource;
     }
}

 

 

 

　　六、在springBoot-user-zuul-swagger的application.yml中添加相關配置：

　　

spring:
  application:
    name: springBoot-user-zuul
zuul:
  prefix: /study-proxy
  ignored-services: "*"
  routes: 
    microcloud-provider-company: /company-proxy/**
    ls-prevention-check: /prevention-check/**

 

　　七、訪問http://localhost:9501/swagger-ui.html