API Management サービスについて理解する
API Management には、開発者の取り組み、ビジネス分析情報、分析、セキュリティ、保護を通じて API プログラムを確実に成功させるためのコア機能が用意されています。 API はそれぞれ、少なくとも 1 つの操作で構成され、1 つまたは複数の成果物に追加することができます。 API を使用する開発者は、その API を含んだ成果物をサブスクライブしたうえで、使用ポリシーが適用されていればその範囲の中で、API の操作を呼び出すことができます。
API Management コンポーネント
Azure API Management は、API ''ゲートウェイ''、''管理プレーン''、''開発者ポータル'' で構成されています。 これらのコンポーネントは、既定で Azure によってホストされて完全に管理されています。 API Management は、容量と機能が異なるさまざまなレベルで使用できます。
API ゲートウェイ。これは次の機能を持つエンドポイントです。
- API 呼び出しを受け取り、適切なバックエンドにルーティングします。
- 要求時に提示された API のキーとその他の資格情報を確認します
- 使用量クォータとレート制限を適用します
- ポリシー ステートメントで指定されている要求と応答を変換します
- 応答の待機時間を短縮し、バックエンド サービスへの負荷を最小限に抑えるために応答をキャッシュします
- 監視、レポート、およびトラブルシューティングのためのログ、メトリック、トレースを出力します
管理プレーンは、API プログラムを設定する管理インターフェイスです。 これは次の目的で使用されます。
- API Management サービス設定をプロビジョニングして構成する
- API スキーマを定義またはインポートします
- API を製品にパッケージ化する
- API のクォータや変換などのポリシーを設定する
- 分析から洞察を得る
- ユーザーの管理
開発者ポータルは、自動的に生成され、完全にカスタマイズ可能な、API のドキュメントが含まれる Web サイトです。 開発者は、開発者ポータルを使用して次のことができます。
- API のドキュメントを読む
- 対話型コンソールを介して API を呼び出す
- API キーを取得するためにアカウントを作成してサブスクライブする
- 自分自身の使用に関する分析にアクセスする
- API 定義をダウンロードする
- API キーを管理する
製品
開発者から見える API の全体像が成果物です。 API Management の成果物には、少なくとも 1 つの API が含まれており、タイトルや説明、使用条件などが設定されます。 成果物の種類には、オープンな成果物と保護された成果物があります。 保護された成果物を使用するには、事前にサブスクライブする必要があります。一方、オープンな成果物は、サブスクライブせずに使用できます。 サブスクリプションの承認は成果物レベルで構成します。管理者による承認を必須とするか自動的に承認するかを選択できます。
グループ
開発者に成果物の表示を許可するかどうかは、グループを使用して管理します。 API Management には、次に示すシステム グループが用意されています。これらのシステム グループを変更することはできません。
- 管理者 - API Management サービス インスタンスを管理し、開発者が使用する API、操作、および製品を作成します。 Azure サブスクリプション管理者は、このグループのメンバーになります。
- 開発者 - API を使用してアプリケーションを構築する認証された開発者ポータル ユーザー。 開発者は、開発者ポータルへのアクセスが認められており、API の操作を呼び出すアプリケーションを構築します。
- ゲスト - 認証されていない開発者ポータル ユーザー。 特定の読み取り専用アクセスを許可できます (API の閲覧はできるが、呼び出しはできないなど)。
管理者は、これらのシステム グループに加えて、カスタム グループを作成することや、関連する Microsoft Entra テナントにある外部グループを使うことができます。
開発者向け
開発者は、API Management サービス インスタンス内のユーザー アカウントです。 開発者アカウントは、管理者が作成したり参加を呼びかけたりすることができるほか、開発者ポータルからサインアップすることもできます。 それぞれの開発者はグループ (複数可) に所属し、そのグループに閲覧が認められている成果物をサブスクライブすることができます。
ポリシー
API の要求または応答に対して順に実行される一連のステートメントが集まってポリシーが形成されます。 代表的なステートメントとしては、XML 形式から JSON 形式への変換や、(開発者からの呼び出しの回数を制限する) 呼び出しレート制限が挙げられ、他にも数多くのポリシーが利用できます。
ポリシーの式は、ポリシーで特に指定されていない限り、任意の API Management ポリシーで属性値またはテキスト値として使用できます。 制御フロー ポリシーや変数の設定ポリシーなど、一部のポリシーはポリシーの式に基づいています。
ポリシーは、ニーズに応じて異なるスコープ (グローバル (すべての API)、製品、特定の API、または API 操作) で適用できます。