1. Homepage
  2. API Governance

  3. Exchange での準拠状況の表示

Exchange での準拠状況の表示

Exchange では、以下を行うことができます。

  • API の準拠状況の表示

  • ルールセットに合格する管理対象 API の表示

API の準拠状況の表示

Exchange では、API 定義のバージョンごとにガバナンス準拠状況を表示できます。状況は次のいずれかになります。

  • Conformant (準拠)​: API 仕様は、検証されたガバナンスルールセットに準拠しています。

  • Not Conformant (非準拠)​: API 仕様は、検証されたガバナンスルールセットに準拠していません。

  • Not Validated (未検証)​: API 仕様は、ガバナンスルールセットに対して検証されていません。

Exchange では、準拠状況を次のように表示できます。

  • 選択した API バージョンに準拠バッジが表示されます。

  • [Manage Versions (バージョンを管理)]​ ページで、各 API バージョンの ​[Conformance (準拠)]​ 列に準拠状況が表示されます。

  • すべての REST API と AsyncAPI について ​[Conformance Status (準拠状況)]​ ページが表示されます。選択した API バージョンがガバナンスルールセットに対して検証済みである場合、準拠状況ページには、準拠情報と非準拠バージョンを修正するためのオプションが表示されます。[Conformance Status (準拠状況)] ページには、リストされているルールセットに対して API が検証されたときの検索条件も表示されます。

準拠状況を表示する手順は、次のとおりです。

  1. API Governance でサポートされている種別の API アセットを選択します。

  2. 準拠バッジを確認します。

  3. バージョンごとの準拠を確認するには、​[Manage Versions (バージョンの管理)]​ をクリックします。

    [Conformance (準拠)]​ 列で、各検証済みバージョンのガバナンス準拠状況を確認します。

  4. 準拠の詳細を表示するには、ナビゲーションバーで ​[Conformance Status (準拠状況)]​ を選択します。 [Conformance Status (準拠状況)] ページでは次の操作が行えます。

    • 表示する API バージョンを選択します。

    • 検証済みの API では、API が検証された、一元化されたガバナンスルールセットのリストと、追加のルールセットを表示します。

      • ルールセットが最初のページに入りきらない場合は、​[Show All (すべて表示)]​ リンクをクリックしてリスト全体を表示します。

      • ルールセットの横にある外部リンクアイコンをクリックして、そのルールセットのページを Exchange で表示します。

    • 非準拠 API では、次のいずれかをクリックします。

      • Design Center で修復する

        API 仕様を Design Center で開いたら、リストされているルールセットを連動関係として追加し、​[Project Errors (プロジェクトエラー)]​ セクションの準拠メッセージを確認して、API 仕様を修復してから再パブリッシュします。
        Design Center の既存のバージョンなしにアセットを直接 Exchange でパブリッシュすると、参照のみバージョンのプロジェクトが開きます。準拠の問題を修正するには、​Exchange からアセットをダウンロード​して、​Design Center にインポートし​、同じ ID と新しいマイナーバージョンを使用して ​Exchange にパブリッシュ​します。

      • Anypoint CLI の手順を参照する

        ページ上の手順に従って、Anypoint CLI コマンドをコピー、更新、実行し、リストされているルールセットを連動関係として追加して、API 仕様を修復してから再パブリッシュします。

ルールセットの管理された API の表示

ルールセットの ​[Governed APIs (管理された API)]​ ページでは、ルールセットが適用される一元的に管理された API のリストを参照できます。

開発者は ​[Governed APIs (管理された API)]​ リストを次のように使用して、開発するルールセットと API の質を向上させることができます。

  • API でルールセットが失敗した場合、API を修正できるように他のどの API がルールセットに正常に準拠しているかを確認できます。

  • API に使用できるルールセットを検索するときに、どの API が特定のルールセットに準拠しているかを確認してそのルールセットがどの程度役に立つかを評価できます。

API コンシューマーは、特定の基準またはルールのセットに準拠した API サービスまたはアプリケーションを作成する必要があるときに、​[Governed APIs (管理された API)]​ リストを使用できます。以下を行うことができます。

  • 必要なルールがある Exchange にルールセットがあることを確認する。

  • アプリケーションが準拠している API のみをコンシュームするように、どの API がルールセットのルールに合格するかを確認する。

Exchange の API に対して持っているアクセス権に応じて、ルールセットに準拠した API しか表示されない場合もあります。これにより、API に対する十分なアクセス権を持たないコンシューマーに脆弱性が曝されないようにできます。組織のシステム管理者やコントリビューターは組織の準拠した API と非準拠の API を確認できます。

ルールセットの管理された API リストを表示する手順は、次のとおりです。

  1. API Governance プロファイルで使用されるルールセットアセットを選択します。

  2. ナビゲーションバーで ​[Governed APIs (管理された API)]​ を選択し、リストされた各 API バージョンがルールセットのすべてのルールに合格するかどうかを確認します。

  3. 検索条件メニューの中から API のリストを絞り込む検索条件を選択します。デフォルト設定は次のとおりです。

    • すべての API

    • ルート組織

    • 任意のルールセット状況

  4. API の ​[Conformance Status (準拠状況)]​ の詳細を表示するには、外部リンクを開くアイコン (​open external link icon​) をクリックします。

関連情報