Spring API Gateway と Micronaut を使用した API ゲートウェイからのマイクロサービスの集約 Swagger UI
このガイドでは、マイクロサービス API ドキュメントを合理化するために、Swagger 3 (OpenAPI) と Spring Cloud Gateway を統合する方法を示します。 Java 21、Spring Boot 3.2、Micronaut を活用して、堅牢でユーザーフレンドリーなソリューションを作成します。
Swagger/OpenAPI を選択する理由
現在 OpenAPI 仕様 (OAS) となっている 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 の動作を示しています。
クライアントリクエストは、定義されたルートに対して評価されます。 一致するリクエストはゲートウェイ Web ハンドラーによって処理され、リクエスト プロキシの前後にプレフィルターとポストフィルターが実行されます。
アプリケーションの構築:
前提条件:
- ジャワ 21
- Gradle (または Maven)
- Spring Boot 3.2 以降
- Spring Cloud Gateway と Swagger についての理解
- マイクロノート
段階的な実装:
ステップ 1: Micronaut アプリケーション (ジョブ、特典、タグ サービス) を作成する
Micronaut Launcher ([ランチャーへのリンク]) を使用して、3 つの Micronaut アプリケーション、job-service
、perk-service
、tag-service
を作成します。 機能として Java または Kotlin、最新の安定した Micronaut バージョン、Swagger UI、および OpenAPI を選択します。 ビルド ツールとして Gradle または Maven を使用します。 各サービスには、アクセス可能な Swagger UI があります (例: http://localhost:8081/swagger-ui/index.html
の場合は 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
について繰り返し、パッケージ名を適宜調整します)。
ステップ 2: Spring Boot API ゲートウェイを作成する
Spring Initializr ([Spring Initializr へのリンク]) を使用して Spring Boot プロジェクトを生成します。 次の依存関係を含めます: Spring Cloud Gateway、Spring Boot Actuator、Spring Web。
ステップ 3: Swagger を API ゲートウェイに統合する
必要な 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
を構成し、各マイクロサービスの 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: アプリケーションを実行する
4 つのアプリケーション (3 つの Micronaut サービスと Spring Boot 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 中国語 Web サイトの他の関連記事を参照してください。

ホットAIツール

Undresser.AI Undress
リアルなヌード写真を作成する AI 搭載アプリ

AI Clothes Remover
写真から衣服を削除するオンライン AI ツール。

Undress AI Tool
脱衣画像を無料で

Clothoff.io
AI衣類リムーバー

Video Face Swap
完全無料の AI 顔交換ツールを使用して、あらゆるビデオの顔を簡単に交換できます。

人気の記事

ホットツール

メモ帳++7.3.1
使いやすく無料のコードエディター

SublimeText3 中国語版
中国語版、とても使いやすい

ゼンドスタジオ 13.0.1
強力な PHP 統合開発環境

ドリームウィーバー CS6
ビジュアル Web 開発ツール

SublimeText3 Mac版
神レベルのコード編集ソフト(SublimeText3)

ホットトピック











一部のアプリケーションが適切に機能しないようにする会社のセキュリティソフトウェアのトラブルシューティングとソリューション。多くの企業は、内部ネットワークセキュリティを確保するためにセキュリティソフトウェアを展開します。 ...

多くのアプリケーションシナリオでソートを実装するために名前を数値に変換するソリューションでは、ユーザーはグループ、特に1つでソートする必要がある場合があります...

システムドッキングでのフィールドマッピング処理は、システムドッキングを実行する際に難しい問題に遭遇することがよくあります。システムのインターフェイスフィールドを効果的にマッピングする方法A ...

intellijideaultimatiateバージョンを使用してスプリングを開始します...

データベース操作にMyBatis-Plusまたはその他のORMフレームワークを使用する場合、エンティティクラスの属性名に基づいてクエリ条件を構築する必要があることがよくあります。あなたが毎回手動で...

Javaオブジェクトと配列の変換:リスクの詳細な議論と鋳造タイプ変換の正しい方法多くのJava初心者は、オブジェクトのアレイへの変換に遭遇します...

eコマースプラットフォーム上のSKUおよびSPUテーブルの設計の詳細な説明この記事では、eコマースプラットフォームでのSKUとSPUのデータベース設計の問題、特にユーザー定義の販売を扱う方法について説明します。

Redisキャッシュソリューションは、製品ランキングリストの要件をどのように実現しますか?開発プロセス中に、多くの場合、ランキングの要件に対処する必要があります。
