API インスタンスでの準拠の問題の検出と修正

Anypoint API Governance によって API インスタンスでの準拠の問題が特定されたら、ガバナンス検証レポートの詳細を表示して、問題を修正するために必要な情報を取得できます。修正する必要があるものを特定したら、API Manager でインスタンスに移動して問題を修正します。問題が仕様のインスタンス関連の問題である場合は、API Designer などの API エディターを使用して仕様を修正します。

API Governance のガバナンスレポートページのスクリーンショット
1 API が検証されるルールセットの概要を確認します。
2 Exchange でルールセットを確認します。
3 タブを選択して、特定の API アスペクトの準拠情報を確認します。
4 Exchange で API を確認します。
5 特定のルールセットに対して特定された準拠の詳細を確認します。
6 Design Center で API コードを確認します。

ガバナンスレポートで準拠の問題の詳細を表示する

ガバナンス検証レポートでインスタンスの準拠の問題を表示する手順は、次のとおりです。

  1. レポートに移動します。

    • Anypoint API Governance で、次の操作を実行します。

      1. API Governance コンソールで、​[Governed APIs (管理対象 API)]​ タブを選択します。

      2. [Instances (インスタンス)]​ 列に ​[Nonconformant (非準拠)]​ バッジが表示されている場合、​[View Report (レポートの表示)]​ をクリックして準拠の問題に関する情報を確認します。

    • API Manager で、次の操作を実行します。

      1. 非準拠としてマークされているインスタンスの ​[Conformance Report (準拠レポート)]​ ページを選択します。

  2. 各ルールセットの非準拠の詳細を表示します。

    • 非準拠の重要度のアイコンをクリックすると、その重要度の問題の詳細が表示されます。

    • [View Details (詳細を表示)]​ をクリックすると、準拠の問題の完全な詳細が表示されます。

ルールセット内のルールの詳細を表示する

ガバナンス検証レポートと準拠の問題の詳細が問題の解決に役立たない場合は、Exchange でルールセットを開いて、API が準拠していないルールの説明とメッセージを表示します。

サンプルルールと推奨される修正

次の表は、いくつかのサンプルルールと、それらのルールへの準拠を修正するために実行するアクションを示しています。

ルール アスペクト 推奨される修正

<policy-name-a> ポリシーは <policy-name-b> ポリシーの前に設定する必要がある

インスタンス ID

API Manager で、ルールで提案されているようにインスタンスのポリシーを再配置します。

API インスタンスに適用される <policy-name> ポリシーがない

インスタンス ID

API Manager で、指定されたポリシーをインスタンスに追加します。

すべての API インスタンスのサーバー URL は API 仕様に記述されている必要がある

仕様

仕様を編集し、そのすべての API インスタンス URL の説明を追加します。