API Management ポリシーのサンプルAPI Management policy samples

ポリシーは、発行者がその構成を通じて API の動作を変更できる、システムの強力な機能の 1 つです。Policies are a powerful capability of the system that allows the publisher to change the behavior of the API through configuration. API の要求または応答に対して順に実行される一連のステートメントが集まってポリシーが形成されます。Policies are a collection of statements that are executed sequentially on the request or response of an API. 次の表にサンプルへのリンクを掲載しています。各サンプルには簡単な説明がついています。The following table includes links to samples and gives a brief description of each sample.

受信ポリシーInbound policies
転送ヘッダーを追加してバックエンド API が適切な URL を構築できるようにするAdd a Forwarded header to allow the backend API to construct proper URLs 受信要求に転送ヘッダーを追加して、バックエンド API が適切な URL を構築できるようにする方法を説明します。Demonstrates how to add a Forwarded header in the inbound request to allow the backend API to construct proper URLs.
相関 ID を含むヘッダーを追加するAdd a header containing a correlation id 相関 ID を含むヘッダーを受信要求に追加する方法を示します。Demonstrates how to add a header containing a correlation ID to the inbound request.
バックエンド サービスに機能を追加して応答をキャッシュするAdd capabilities to a backend service and cache the response バックエンド サービスに機能を追加する方法を示します。Shows how to add capabilities to a backend service. たとえば、天気予報 API で、緯度と経度ではなく場所の名前を受け入れます。For example, accept a name of the place instead of latitude and longitude in a weather forecast API.
JWT クレームに基づくアクセスを承認するAuthorize access based on JWT claims API の特定の HTTP メソッドに対して、JWT クレームに基づくアクセスを承認する方法を示します。Shows how to authorize access to specific HTTP methods on an API based on JWT claims.
外部承認者を使用して要求を承認するAuthorize requests using external authorizer API のアクセスを保護するための外部承認者の使用方法を示します。Shows how to use external authorizer for securing API access.
Google OAuth トークンを使用してアクセスを承認するAuthorize access using Google OAuth token OAuth トークン プロバイダーに Google を使用して、エンドポイントへのアクセスを承認する方法を示します。Shows how to authorize access to your endpoints using Google as an OAuth token provider.
Shared Access Signature を生成して Azure ストレージへ要求を転送するGenerate Shared Access Signature and forward request to Azure storage 式を使用して Shared Access Signature を生成し、rewrite-uri ポリシーを使用して Azure ストレージに要求を転送する方法を示します。Shows how to generate Shared Access Signature using expressions and forward the request to Azure storage with rewrite-uri policy.
AAD から OAuth2 アクセス トークンを取得してバックエンドに転送するGet OAuth2 access token from AAD and forward it to the backend ゲートウェイとバックエンドとの間の承認に OAuth2 を使用する例を示します。Provides and example of using OAuth2 for authorization between the gateway and a backend. AAD からアクセス トークンを取得してバックエンドに転送する方法を示します。It shows how to obtain an access token from AAD and forward it to the backend.
送信要求ポリシーを使用して SAP ゲートウェイから X-CSRF トークンを取得するGet X-CSRF token from SAP gateway using send request policy 多くの API で使用される X-CSRF パターンを実装する方法を示します。Shows how to implement X-CSRF pattern used by many APIs. この例は SAP ゲートウェイに固有のものです。This example is specific to SAP Gateway.
本文のサイズに基づいて要求をルーティングするRoute the request based on the size of its body 本文のサイズに基づいて要求をルーティングする方法を示します。Demonstrates how to route requests based on the size of their bodies.
バックエンド サービスに要求コンテキスト情報を送信するSend request context information to the backend service 一部のコンテキスト情報をログ記録や処理のためにバックエンド サービスに送信する方法を示します。Shows how to send some context information to the backend service for logging or processing.
応答をキャッシュする期間を設定するSet response cache duration バックエンドによって送信される Cache-control ヘッダーの maxAge 値を使用して、応答のキャッシュ期間を設定する方法を示します。Demonstrates how to set response cache duration using maxAge value in Cache-Control header sent by the backend.
送信ポリシーOutbound policies
応答の内容をフィルターするFilter response content 要求に関連付けられている製品に基づいて応答ペイロードのデータ要素をフィルターする方法を示します。Demonstrates how to filter data elements from the response payload based on the product associated with the request.
エラー時のポリシーOn-error policies
Stackify にエラーのログを記録するLog errors to Stackify エラー ログ ポリシーを追加して、ログ記録のために Stackify にエラーを送信する 方法を示します。Shows how to add an error logging policy to send errors to Stackify for logging.