このガイドでは、マイクロサービス API ドキュメントを合理化するために、Swagger 3 (OpenAPI) と Spring Cloud Gateway を統(tǒng)合する方法を示します。 Java 21、Spring Boot 3.2、Micronaut を活用して、堅(jiān)牢でユーザーフレンドリーなソリューションを作成します。

Swagger/OpenAPI を選択する理由

現(xiàn)在 OpenAPI 仕様 (OAS) となっている Swagger は、主要な API ドキュメント標(biāo)準(zhǔn)です。その利點(diǎn)は次のとおりです:

• 業(yè)界標(biāo)準(zhǔn): ツールの豊富なエコシステムによって広く採(cǎi)用され、サポートされています。
• インタラクティブなドキュメント: 開(kāi)発者が API を直接調(diào)べてテストできるようにする、ユーザーフレンドリーなドキュメントを生成します。
• 開(kāi)発者の生産性の向上: SDK のコード生成やサーバー スタブなどの機(jī)能により、API 開(kāi)発が加速します。
• コラボレーションの強(qiáng)化: 開(kāi)発者、テスター、関係者に API 機(jī)能の共通理解を提供します。
• 簡(jiǎn)素化されたテストとデバッグ: Swagger UI には、API 応答を検証するためのテスト インターフェイスが含まれています。
• 言語(yǔ)間のサポート: 多様なテクノロジー スタック間でシームレスに統(tǒng)合します。
• 簡(jiǎn)単な統(tǒng)合: Spring Boot や Micronaut などの人気のあるフレームワークとの簡(jiǎn)単な統(tǒng)合。
• 自動(dòng)化に優(yōu)しい: API ライフサイクル管理の自動(dòng)化をサポートします。
• エンタープライズ オプション付きのオープン ソース: エンタープライズ オプション付きの無(wú)料のオープンソース ツールとして利用できます。

Spring Cloud Gateway: 財(cái)団

Spring Framework 5、Spring Boot 2、Project Reactor 上に構(gòu)築された Spring Cloud Gateway は、マイクロサービスへのリクエストのルーティングとフィルター処理の中心的なエントリ ポイントとして機(jī)能します。

Spring Cloud Gateway の機(jī)能:

以下の図は、Spring Cloud Gateway の動(dòng)作を示しています。

クライアントリクエストは、定義されたルートに対して評(píng)価されます。 一致するリクエストはゲートウェイ Web ハンドラーによって処理され、リクエスト プロキシの前後にプレフィルターとポストフィルターが実行されます。

アプリケーションの構(gòu)築:

前提條件:

1. ジャワ 21
2. Gradle (または Maven)
3. Spring Boot 3.2 以降
4. Spring Cloud Gateway と Swagger についての理解
5. マイクロノート

段階的な実裝:

ステップ 1: Micronaut アプリケーション (ジョブ、特典、タグ サービス) を作成する

Micronaut Launcher ([ランチャーへのリンク]) を使用して、3 つの Micronaut アプリケーション、job-service、perk-service、tag-service を作成します。 機(jī)能として Java または Kotlin、最新の安定した Micronaut バージョン、Swagger UI、および OpenAPI を選択します。 ビルド ツールとして Gradle または Maven を使用します。 各サービスには、アクセス可能な Swagger UI があります (例: http://localhost:8081/swagger-ui/index.html の場(chǎng)合は job-service)。 CLI を使用することもできます:

mn create-app --build=gradle_kotlin --jdk=21 --lang=java --test=junit --features=openapi,swagger-ui dev.job.job

(perk-service と tag-service について繰り返し、パッケージ名を適宜調(diào)整します)。

ステップ 2: Spring Boot API ゲートウェイを作成する

Spring Initializr ([Spring Initializr へのリンク]) を使用して Spring Boot プロジェクトを生成します。 次の依存関係を含めます: Spring Cloud Gateway、Spring Boot Actuator、Spring Web。

ステップ 3: Swagger を API ゲートウェイに統(tǒng)合する

必要な Springdoc 依存関係を pom.xml (Maven) または build.gradle (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")
}

Swagger UI を有効にするように application.yml を構(gòu)成し、各マイクロサービスの Swagger YAML ファイルの URL を指定します。

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

application.yml:

server:
  port: 8080
spring:
  application:
    name: web-api-gateway

ステップ 4: アプリケーションを?qū)g行する

4 つのアプリケーション (3 つの Micronaut サービスと Spring Boot Gateway) をそれぞれ起動(dòng)します。 ゲートウェイの Swagger UI には、http://localhost:8080/webjars/swagger-ui/index.html からアクセスできます。

結(jié)論:

この組み合わせアプローチにより、強(qiáng)力で十分に文書(shū)化されたマイクロサービス アーキテクチャが提供されます。 Spring Cloud Gateway はリクエストを効率的にルーティングし、Swagger は一元化されたインタラクティブな API ドキュメント エクスペリエンスを提供します。 この設(shè)定により、開(kāi)発者の生産性とコラボレーションが大幅に向上します。必ずプレースホルダー URL をマイクロサービスの Swagger YAML ファイルの実際の URL に置き換えてください。

以上がSpring API Gateway と Micronaut を使用した API ゲートウェイからのマイクロサービスの集約&# Swagger UIの詳細(xì)內(nèi)容です。詳細(xì)については、PHP 中國(guó)語(yǔ) Web サイトの他の関連記事を參照してください。