注: このプロダクトの一部の機能はベータ版です。ハイブリッド インストール オプションは一般提供です。ベータ版プログラムに参加するには、Apigee の担当者にお問い合わせください。

ポリシーとは

Apigee では、「ポリシー」を使用することで、コードを記述せずに API の動作を「プログラム」できます。ポリシーは、特定の限定された管理機能を実装するモジュールのようなものです。ポリシーを使用すると、一般的な管理機能を簡単かつ確実に API に追加できます。ポリシーには、セキュリティ、レート制限、変換、仲介などの機能が備わっているため、こうした機能を自分でコーディングして維持する必要がありません。

Apigee で提供されるポリシータイプのセットに制限されません。カスタムのスクリプトとコード(JavaScript アプリケーションなど)を作成して API プロキシの機能を拡張し、Apigee のポリシーでサポートされる基本的な管理機能を基に革新的な機能を装備することもできます。

ポリシーの接続と適用の概要については、こちらの動画をご覧ください。

ポリシーの種類

技術的には、ポリシーは XML 形式の構成ファイルです。各ポリシータイプの構造(たとえば、必須、オプションの構成要素)は、XML スキーマによって定義されます。XML ツールに精通している場合は、GitHub のAPI Platform のサンプルでポリシー スキーマを理解しておくことをおすすめします。

Apigee ポリシーのタイプは、以下の機能カテゴリに分類されます。

トラフィック管理

トラフィック管理カテゴリのポリシーでは、API プロキシを通じて、リクエスト メッセージとレスポンス メッセージのフローを制御できます。これらのポリシーは、運用レベルと業務レベルの両方の制御をサポートします。これを使用することで、未加工のスループットを制御できるほか、アプリごとにトラフィックを制御することも可能です。トラフィック管理ポリシータイプは割り当てを適用するために使用できます。また、サービス拒否攻撃の防御にも役立ちます。

セキュリティ

セキュリティ カテゴリのポリシーは、認証、認可、コンテンツ ベースのセキュリティをサポートします。

メディエーション

メディエーション カテゴリのポリシーを使用すると、API プロキシ内のフローを通過するメッセージをアクティブに操作できます。これらのポリシーにより、メッセージ形式を XML から JSON(またはその逆)に変換でき、特定の XML 形式を別の XML 形式に変換することもできます。また、メッセージの解析、新しいメッセージの生成、送信メッセージの値の変更もできます。さらに、メディエーション ポリシーは、API Service によって公開される基本的なサービスともやり取りするため、アプリ、デベロッパー、セキュリティ トークン、API 製品に関するデータを実行時に取得できます。

拡張機能

拡張機能カテゴリのポリシーでは、API Service の拡張性を利用して、選択したプログラミング言語でカスタムの動作を実装できます。

各ポリシータイプの詳細については、ポリシー リファレンスの概要をご覧ください。このトピックでは、一般的な使い方について説明し、ポリシーの作成方法と、API プロキシ構成内のフローにポリシーを接続する方法を示します。

ポリシーの変更をデプロイする

ポリシーの変更を有効にするには、API プロキシ リビジョンを環境にデプロイする必要があります。ポリシーを接続するか、既存のポリシーを変更した後、Apigee UI または Apigee API を使用して変更をデプロイします。

ポリシー適用の検証

ポリシーが適切に適用されているかどうかを検証するには、HTTP クライアントで API を呼び出す必要があります。割り当て構成を検証する場合は、複数のリクエストを API に送信して、割り当てポリシーに設定した割り当て制限を超過するようにします。URI パスは ProxyEndpoint のベースパス設定に従って構成されており、以下のリクエストでは /weather になっています。

http://{org_name}-test.apigee.net/weather/forecastrss?w=12797282

1 分以内に複数のリクエストを送信すると、次のエラー メッセージが表示されるはずです。

{
   "fault":{
      "faultstring":"policies.ratelimit.QuotaViolation",
      "detail":{
         "errorcode":"policies.ratelimit.QuotaViolation"
      }
   }
}

これは、割り当てポリシーが API サービスによって適用されていることを示します。

ポリシーベースの障害処理

上記のエラー メッセージの形式に注目してください。faultstring プロパティと errorcode プロパティが含まれています。多くの場合、こうしたエラーを処理するには、いくつかの動作を実装する必要があります。たとえば、アプリが割り当てを超えたデベロッパーにカスタマイズしたメッセージを送信することができます。

障害処理の詳細については、障害の処理をご覧ください。

おすすめの方法: 一般的なポリシーセット

基本的な管理要件を満たすために、API プロキシは通常、次のポリシーを適用します。

基本的な API キー検証

ProxyEndpoint リクエスト フロー:
  1. SpikeArrest
  2. XMLThreatProtection または JSONThreatProtection
  3. API キーの検証
  4. 割り当て
  5. ResponseCache
ProxyEndpoint レスポンス フロー:
  1. ResponseCache

基本的な変換: JSON から XML

リクエスト フロー:
  1. SpikeArrest
  2. JSONThreatProtection
  3. API キーの検証
  4. 割り当て
  5. JSONtoXML
レスポンス フロー:
  1. XMLtoJSON
  2. ResponseCache