Spring API Gateway 및 Micronaut를 사용하여 API 게이트웨이에서 마이크로서비스 및 Swagger UI 집계

이 가이드에서는 간소화된 마이크로서비스 API 문서화를 위해 Swagger 3(OpenAPI)를 Spring Cloud Gateway와 통합하는 방법을 보여줍니다. Java 21, Spring Boot 3.2 및 Micronaut를 활용하여 강력하고 사용자 친화적인 솔루션을 만들겠습니다.

Swagger/OpenAPI를 선택하는 이유는 무엇입니까?

현재 OAS(OpenAPI 사양)인 Swagger는 선도적인 API 문서 표준입니다. 그 이점은 다음과 같습니다.

• 업계 표준: 풍부한 도구 생태계를 통해 널리 채택되고 지원됩니다.
• 대화형 문서: 개발자가 API를 직접 탐색하고 테스트할 수 있도록 사용자 친화적인 문서를 생성합니다.
• 개발자 생산성 향상: SDK 및 서버 스텁용 코드 생성과 같은 기능으로 API 개발을 가속화합니다.
• 향상된 협업: 개발자, 테스터 및 이해관계자를 위한 API 기능에 대한 공통된 이해를 제공합니다.
• 간소화된 테스트 및 디버깅: Swagger UI에는 API 응답을 검증하기 위한 테스트 인터페이스가 포함되어 있습니다.
• 교차 언어 지원: 다양한 기술 스택을 완벽하게 통합합니다.
• 쉬운 통합: Spring Boot 및 Micronaut와 같은 널리 사용되는 프레임워크와 간단하게 통합됩니다.
• 자동화 친화적: API 수명주기 관리 자동화를 지원합니다.
• 엔터프라이즈 옵션이 포함된 오픈 소스: 엔터프라이즈 옵션이 포함된 무료 오픈 소스 도구로 제공됩니다.

Spring Cloud Gateway: 재단

Spring Framework 5, Spring Boot 2 및 Project Reactor를 기반으로 구축된 Spring Cloud Gateway는 마이크로서비스에 대한 요청을 라우팅하고 필터링하기 위한 중앙 진입점 역할을 합니다.

Spring Cloud Gateway의 작동 방식:

아래 다이어그램은 Spring Cloud Gateway의 작동을 보여줍니다.

클라이언트 요청은 정의된 경로를 기준으로 평가됩니다. 일치하는 요청은 요청 프록시 전후에 사전 및 사후 필터를 실행하는 게이트웨이 웹 처리기에 의해 처리됩니다.

애플리케이션 구축:

전제 조건:

1. 자바 21
2. Gradle(또는 Maven)
3. Spring Boot 3.2 이상
4. Spring Cloud Gateway와 Swagger의 이해
5. 마이크로너트

단계별 구현:

1단계: Micronaut 애플리케이션 생성(Job, Perk, Tag Services)

Micronaut Launcher([런처 링크])를 사용하여 job-service, perk-service 및 tag-service 세 가지 Micronaut 애플리케이션을 만듭니다. Java 또는 Kotlin, 안정적인 최신 Micronaut 버전, Swagger UI 및 OpenAPI를 기능으로 선택하세요. Gradle 또는 Maven을 빌드 도구로 사용합니다. 각 서비스에는 액세스 가능한 Swagger UI가 있습니다(예: http://localhost:8081/swagger-ui/index.html의 경우 job-service). CLI를 사용할 수도 있습니다:

<code class="language-bash">mn create-app --build=gradle_kotlin --jdk=21 --lang=java --test=junit --features=openapi,swagger-ui dev.job.job</code>

(perk-service 및 tag-service에 대해 반복하고 이에 따라 패키지 이름을 조정).

2단계: Spring Boot API 게이트웨이 생성

Spring 초기화([Spring 초기화에 대한 링크])를 사용하여 Spring Boot 프로젝트를 생성하세요. Spring Cloud Gateway, Spring Boot Actuator 및 Spring Web과 같은 종속성을 포함합니다.

3단계: Swagger를 API 게이트웨이에 통합

pom.xml(Maven) 또는 build.gradle(Gradle)에 필요한 Springdoc 종속성을 추가합니다.

<code class="language-gradle">dependencies {
    implementation("org.springframework.cloud:spring-cloud-starter-gateway")
    implementation("org.springdoc:springdoc-openapi-starter-webmvc-api:2.8.3")
    implementation("org.springdoc:springdoc-openapi-starter-webflux-ui:2.8.3")
}</code>

Swagger UI를 활성화하고 각 마이크로서비스의 Swagger YAML 파일에 대한 URL을 지정하도록 application.yml을 구성합니다.

<code class="language-yaml">springdoc:
  api-docs:
    enabled: true
  swagger-ui:
    enabled: true
    path: /swagger-ui.html
    config-url: /v3/api-docs/swagger-config
    urls:
      - name: Job Service
        url: http://localhost:8081/swagger/job-service-0.0.yml
      - name: Perk Service
        url: http://localhost:8082/swagger/perk-0.0.yml
      - name: Tag Service
        url: http://localhost:8083/swagger/tag-0.0.yml</code>

application.yml:

에서 API 게이트웨이 포트를 8080으로 설정합니다.

<code class="language-yaml">server:
  port: 8080
spring:
  application:
    name: web-api-gateway</code>

4단계: 애플리케이션 실행

4개의 애플리케이션(3개의 Micronaut 서비스 및 Spring Boot Gateway)을 각각 시작합니다. Gateway의 Swagger UI는 http://localhost:8080/webjars/swagger-ui/index.html.

에서 액세스할 수 있습니다.

결론:

이러한 결합된 접근 방식은 강력하고 잘 문서화된 마이크로서비스 아키텍처를 제공합니다. Spring Cloud Gateway는 요청을 효율적으로 라우팅하는 반면 Swagger는 중앙 집중식 대화형 API 문서 경험을 제공합니다. 이 설정은 개발자 생산성과 협업을 크게 향상시킵니다. 자리 표시자 URL을 마이크로서비스 Swagger YAML 파일의 실제 URL로 바꾸는 것을 잊지 마세요.

위 내용은 Spring API Gateway 및 Micronaut를 사용하여 API 게이트웨이에서 마이크로서비스 및 Swagger UI 집계의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!