ルーティング処理
API Gateway は、リクエストを適切なサービスにルーティングするための機能を提供します。以下のセクションでは、ルーティングの基本的な概念と実装方法について説明します。
SNIによる仮想ホストの特定
API Gateway は最初に SNI で宛先のFQDNを判定します。FQDNをキーとして仮想ホストを特定します。 仮想ホストが登録されていない場合は接続を拒否します。 仮想ホストが登録されている場合は、仮想ホストに設定されているルーティングチェーンを使用してリクエストを処理します。
リクエストライフサイクル
以下に HTTP リクエストのライフサイクルを示します。
- HTTP リクエストのライフサイクルは、API Gatewayがクライアント(downstream)からリクエストヘッダを読み取ったときに始まります。
- API Gateway はバックエンド（upstream）に接続します。再利用できる接続が既に確立されている場合、このステップはスキップされます。
- API Gateway はリクエストヘッダをバックエンドに送信します。
- リクエストヘッダが送信されると、API Gateway は二重モードに入り、同時に次の処理を実行します。
- リクエストのボディ(存在する場合) をバックエンドに転送します
- バックエンドからのレスポンス (ヘッダとボディの両方) をクライアントに転送します
- リクエスト/レスポンス全体が終了すると、リクエストのライフサイクルは終了し、すべてのリソースが解放されます。クライアントとの接続とバックエンドとの接続は、条件を満たせば再利用のために維持されます。
リクエストコンテキスト
ルーティングにおいてはリクエストごとにコンテキストが作成されます。コンテキストには変数、リクエストヘッダ、レスポンスヘッダが保持されます。
API Gateway のフェーズとフィルタ
API Gateway ではルーティングチェーンを記述することでリクエストのライフサイクルに任意のロジックを挿入できます。 以下に、API Gateway の実装ベースである Pingora のフェーズとフィルターのフローを示します。
以下に API Gateway における各フィルタの処理内容を説明します。記載のないフィルタについては Pingora のデフォルトの処理が呼び出されます。
early_request_filter
request_filter()
このフィルターでルーティングチェーンを処理します。
upstream_request_filter()
ルーティングチェーンで set_request_header アクションがあればその内容に従ってバックエンドに送るヘッダの値を変更します。
upstream_response_filter()
ルーティングチェーンで set_response_header アクションがあればその内容に従ってレスポンスヘッダの値を変更します。 このフェーズでは、下流に送信する前に、レスポンスのヘッダーを変更します。このフェーズはHTTPキャッシュの前に呼び出されるため、ここで行われた変更はHTTPキャッシュに保存されているレスポンスに影響することに注意してください。
ルーティングチェーンの処理
ルーティングチェーンはルールのリストであり、順にルールの match 条件を評価し、条件を満たしたルールのアクションを実行します。各アクションについて次の章で説明します。
サービス待ちSSE
API Gateway ではサービスが利用可能になるのを待つための SSE (Server-Sent Events) を提供します。
Chip-in Wait for Services API (1.0.0)
Download OpenAPI specification:Download
これはChip-in の仮想ホストで提供されるサービスが利用可能になるのを待つためのAPIの仕様です。
Wait for Services.
Authorizations:
query Parameters
| services required | Array of strings Example: services=urn:chip-in:service:example-realm:example-service,urn:chip-in:service:example-realm:another-service A comma-separated list of service URNs to wait for. The API will return when all specified services are available. |
Responses
Response samples
- 200
- 404
- default
[- "urn:chip-in:service:example-realm:example-service",
- "urn:chip-in:service:example-realm:another-service"
]