Spring Cloud Zuul集成Swagger實現過程解析

Spring Cloud Zuul 集成Swagger

1.準備服務注冊中心eureka-server

2.創建微服務swagger-service-a

step1. 創建微服務swagger-service-a(Spring Boot項目)，添加eureka-client起步依賴，web起步依賴 和swagger依賴

<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId> </dependency> <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <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>

step2.在配置類添加注解@EnableDiscoveryClient ，，將當前應用 添加到 服務治理體系中，開啟微服務注冊與發現。

step3.配置swagger

package com.example.swaggerservicea;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import springfox.documentation.builders.ApiInfoBuilder;import springfox.documentation.builders.PathSelectors;import springfox.documentation.builders.RequestHandlerSelectors;import springfox.documentation.service.ApiInfo;import springfox.documentation.spi.DocumentationType;import springfox.documentation.spring.web.plugins.Docket;import springfox.documentation.swagger2.annotations.EnableSwagger2;@Configuration@EnableSwagger2public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.any()).paths(PathSelectors.any()).build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder().title('swagger-service-a 實例文檔').description('swagger-service-a 實例文檔 1.0').termsOfServiceUrl('https:github').version('1.0').build(); }}

step4.application.properties文件中添加配置

#微服務基本信息spring.application.name=swagger-service-aserver.port=10010#注冊中心eureka.client.serviceUrl.defaultZone=http://localhost:1001/eureka/#要生成文檔的packageswagger.base-package=com.example

step5.添加一個微服務提供的功能

import org.springframework.beans.factory.annotation.Autowired;import org.springframework.cloud.client.discovery.DiscoveryClient;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RestController;@RestControllerpublic class AaaController { @Autowired DiscoveryClient discoveryClient; @GetMapping('/service-a') public String dc() { String services = 'service-a Services: ' + discoveryClient.getServices(); System.out.println(services); return services; }}

step6.啟動微服務，訪問 http://localhost:10010/swagger-ui.html

3.創建微服務swagger-service-b （參考swagger-service-a ）， 啟動微服務swagger-service-b并訪問http://localhost:10020/swagger-ui.html

4.構建API網關并整合Swagger

step1.創建API網關微服務swagger-api-gateway，添加eureka-client起步依賴，zuul起步依賴 和 swagger依賴 :spring-cloud-starter-netflix-eureka-client，spring-cloud-starter-netflix-zuul

<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-zuul</artifactId> </dependency> <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <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>

step2.在配置類添加注解@SpringCloudApplication ，@EnableZuulProxy

step3.配置swagger

import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import springfox.documentation.builders.ApiInfoBuilder;import springfox.documentation.builders.PathSelectors;import springfox.documentation.builders.RequestHandlerSelectors;import springfox.documentation.service.ApiInfo;import springfox.documentation.spi.DocumentationType;import springfox.documentation.spring.web.plugins.Docket;import springfox.documentation.swagger2.annotations.EnableSwagger2;@Configuration@EnableSwagger2public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.any()).paths(PathSelectors.any()).build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder().title('swagger-service 實例文檔').description('swagger-service 實例文檔 1.0').termsOfServiceUrl('https:github').version('1.0').build(); }}

step4.配置swagger

package com.example.swaggerapigateway;import java.util.ArrayList;import java.util.List;import org.springframework.context.annotation.Primary;import org.springframework.stereotype.Component;import springfox.documentation.swagger.web.SwaggerResource;import springfox.documentation.swagger.web.SwaggerResourcesProvider;@Component@Primaryclass DocumentationConfig implements SwaggerResourcesProvider { @Override public List<SwaggerResource> get() { List resources = new ArrayList<>(); resources.add(swaggerResource('service-a', '/swagger-service-a/v2/api-docs', '2.0')); resources.add(swaggerResource('service-b', '/swagger-service-b/v2/api-docs', '2.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; }}

step5.application.properties文件中添加配置

#微服務基本信息spring.application.name=swagger-api-gatewayserver.port=10030#注冊中心eureka.client.serviceUrl.defaultZone=http://localhost:1001/eureka/#要生成文檔的packageswagger.base-package=com.example

step6.啟動微服務，訪問http://localhost:10030/swagger-ui.html

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持好吧啦網。