Spring Cloud Zuul 통합 Swagger 실현 과정 분석

스프링 클 라 우 드 Zuul 통합 Swagger
1.서비스 등록 센터 eureka-server 준비
2.마이크로 서비스 swagger-service-a 만 들 기
step 1.마이크로 서비스 swagger-service-a(Spring Boot 프로젝트)를 만 들 고 eureka-client 시작 의존,웹 시작 의존 과 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>

step 2.설정 클래스 에 주석@EnableDiscoveryClient 를 추가 하고 현재 응용 프로그램 을 서비스 관리 시스템 에 추가 하여 마이크로 서비스 등록 과 발견 을 엽 니 다.
step 3.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
@EnableSwagger2
public 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-a
server.port=10010
등록 센터
eureka.client.serviceUrl.defaultZone=http://localhost:1001/eureka/
\#문 서 를 만 들 패키지
swagger.base-package=com.example
step 5.마이크로 서비스 가 제공 하 는 기능 추가

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;

@RestController
public class AaaController {
  @Autowired
  DiscoveryClient discoveryClient;

  @GetMapping("/service-a")
  public String dc() {
    String services = "service-a Services: " + discoveryClient.getServices();
    System.out.println(services);
    return services;
  }
}

step 6.마이크로 서비스 시작,접근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 통합
step 1.API 게 이 트 웨 이 마이크로 서비스 swagger-api-gateway 를 만 들 고 eureka-client 시작 의존,zuul 시작 의존 과 swagger 의존:spring-cloud-starter-netflix-eureka-client,spring-cloud-starter-netflix-zul

<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>

step 2.설정 클래스 에 주 해 를 추가 합 니 다@SpringCloudApplication,@EnableZuulProxy
step 3.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
@EnableSwagger2
public 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();
  }

}

step 4.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
@Primary
class 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;
  }
}

step 5.application.properties 파일 에 설정 추가
\#마이크로 서비스 기본 정보
spring.application.name=swagger-api-gateway
server.port=10030
등록 센터
eureka.client.serviceUrl.defaultZone=http://localhost:1001/eureka/
\#문 서 를 만 들 패키지
swagger.base-package=com.example
step 6.마이크로 서비스 시작,접근http://localhost:10030/swagger-ui.html

이상 이 바로 본 고의 모든 내용 입 니 다.여러분 의 학습 에 도움 이 되 고 저 희 를 많이 응원 해 주 셨 으 면 좋 겠 습 니 다.