拡張機能を使用すると、外部リソースを API プロキシに統合できます。たとえば、Google Cloud Storage などの Google Cloud Platform サービスを統合できます。API プロキシは、ランタイムに拡張機能を使用して、外部リソースとのリクエストやレスポンスの交換を行います。
拡張機能のランタイム フレームワーク
ランタイムに、拡張機能は仲介者として機能し、API プロキシと外部リソース間のリクエストとレスポンスを処理します。
拡張機能によるランタイムの処理は次のとおりです。
- クライアント リクエストが API プロキシに到達すると、そのリクエスト フローはプロキシのポリシーを介して処理されます。
- リクエスト フローが、プロキシ内の Extension Callout ポリシーに到達します。このプロキシは、環境内にデプロイされた拡張機能にデータを渡すように構成されています。このデータには、拡張機能が指定する外部リソースにリクエストを送信するために必要な値が含まれています。
- 拡張機能はリクエストを外部リソースに送信し、レスポンスを受け取ります。
- 拡張機能がレスポンスを Extension Callout ポリシーに渡し、プロキシコードによって処理されます。
- レスポンスがクライアントに返されるまで、リクエスト フローがプロキシ経由で継続します。
拡張機能の操作
拡張機能は、特定の外部リソースと一緒に開発され、構成されます。拡張機能を使用するには、Apigee Edge の管理者と API プロキシの開発者が次の操作を行う必要があります。
- Apigee Edge の拡張機能の構成とデプロイは、組織管理者が行います。ビジネスの要件に適した値を指定して構成します。この構成により、API プロキシの開発者が使用する拡張機能のインスタンスが作成されます。たとえば、Google Cloud Storage の特定のバケット(必要な認証情報を含む)にアクセスするように拡張機能を構成できます。
- API プロキシの開発者は、API プロキシに Extension Callout ポリシーを追加して、構成済みの拡張機能を API プロキシで使用します。プロキシの構成では、次の情報を指定します。
- 使用する拡張機能
- 拡張機能のアクション(拡張機能に対する機能の呼び出し)
- アクション呼び出しで渡すアクション パラメータ。 ランタイムに、ポリシーが拡張機能を使用して、プロキシのフローの一部として外部リソースにアクセスします。
拡張機能のドキュメント
拡張機能については、以下のトピックで詳しく説明しています。
- 拡張機能のハンズオンについては、チュートリアル: 拡張機能の追加と使用をご覧ください。
- Apigee Edge に含まれる拡張機能のリファレンスについては、拡張機能リファレンスの概要をご覧ください。
- 拡張機能の追加、削除、デプロイに使用する管理 API のリファレンスについては、拡張機能の管理 API のリファレンスをご覧ください。