メインコンテンツまでスキップ

API Basic Policy Settings

API基本ポリシーの紹介

API Basic Policy は、プロジェクト内の新しいAPIに自動的に適用される事前定義されたルールと設定のセットです。これらのポリシーは、各APIの手動設定を必要とせず、一貫したセキュリティ対策、リクエスト処理、およびデータ変換を強制するのに役立ちます。

API基本ポリシーの重要性

  • Ensures Consistency: 標準化されたポリシーは、プロジェクト内のすべてのサービスで均一なAPI動作を維持するのに役立ちます。
  • Improves Security: 認証、レート制限、リクエスト検証などのデフォルトのセキュリティ対策は、脆弱性を減少させます。
  • Simplifies API Management: ベストプラクティスの適用を自動化し、手動設定の必要性を減少させます。
  • Enhances Performance: 事前定義された変換ルールは、リクエストとレスポンスの処理を最適化します。

API基本ポリシースクリーンの機能

API Basic Policy スクリーンでは、ユーザーは次のことができます:

  • APIに利用可能なポリシーを表示します。
  • 選択したプロジェクトに対してポリシーを適用または削除します。
  • 実行順序、ヘッダー、リクエスト変換などのポリシーの詳細を設定します。
  • APIポリシーを保存および管理し、新しいAPIデプロイメントに対して強制されることを保証します。

API基本ポリシーの設定方法

プロジェクト内で新しいAPIが作成されると、それは自動的にプロジェクトの設定されたAPI基本ポリシーを継承します。プロジェクトの基本ポリシーを設定するには、ユーザーは以下の手順に従うことができます:

ステップ1: API基本ポリシー設定へのアクセス

  • APIMコンソールのAPI管理セクションに移動します。
  • メニューからAPI基本ポリシーを選択します。
  • リストからプロジェクトを選択します。

プロジェクトが選択されると、API基本ポリシーの設定画面が表示されます。

API基本ポリシー設定へのアクセス

ステップ2: ポリシーの追加または削除

現在適用されていないポリシーは、適用不可セクションにリストされます。

ポリシーを適用するには:

  • 適用不可セクションでポリシーを見つけます。
  • ポリシーの横にある×アイコンをクリックします。
  • ポリシーは適用セクションに移動します。

ポリシーを削除するには:

  • 適用セクションでポリシーを見つけます。
  • マイナス(+)アイコンをクリックします。
  • ポリシーは適用不可セクションに戻されます。

ポリシーの追加または削除

ステップ3: ポリシーの詳細を表示

  • 適用セクションにリストされているポリシーをクリックします。
  • ポリシーの詳細がページの下部に新しいセクションで表示されます。
  • 各ポリシーには独自の設定とパラメータがあります。利用可能な設定フィールドは、特定のポリシータイプによって異なります。各ポリシーのカスタマイズについて詳しく知りたい場合は、ユーザーガイド/APIMコンソールガイド/APIポリシー詳細ガイドを参照してください。

ポリシーの詳細を表示

ステップ4: ポリシーのカスタマイズと保存

  • 必要に応じてポリシー設定を変更します。変更は、その後作成される新しいAPIに適用されます。
  • 右上の保存ボタンをクリックして変更を適用します。

ポリシーのカスタマイズと保存