Anypoint API Governance の概要

ガバナンスプロファイルは、選択したガバナンスルールセットを絞り込んだ API グループに適用します。その後、API Governance はルールセットに対して API を検証し、ガバナンス準拠を判断します。

ガバナンスルールセットは、Anypoint Platform の API から抽出されたメタデータに適用できる、ルールのコレクションまたはガイドラインです。ガバナンスルールセットを適用に使用できる例:

API は、少なくとも 1 つのガバナンスプロファイルの選択条件によって識別された場合に管理されます。API が管理されている場合、その API のすべてのバージョンが 1 つの管理対象 API とみなされます。サブスクリプション制限は、組織の購入済みの容量に基づいて設定されます。UI には使用量に関する情報が表示され、サブスクリプション容量に近づいたり超えたりしたときにアラートが表示されます。

API 準拠は、検証済み API 仕様が 1 つ以上のガバナンスルールセット内のすべての必須ルールに合格するかどうかを示します。API 仕様が複数のガバナンスプロファイルに含まれている場合、準拠するには、それらすべてのプロファイルのすべてのルールセットに合格する必要があります。

API 準拠状況は、ガバナンスプロファイルに含まれている API が適用されるすべてのガバナンスルールセットに合格するかどうかを示します。

準拠の重大度は、すべての必須ルールセットの中で合格したルールセットの割合によって分類されます。

API Governance コンソールのガバナンス状況には、管理対象 API の数、サポート対象 API 種別の API の総数、サブスクリプション制限の情報が表示されます。

API Governance コンソールでプロファイルの状況を確認できます。ガバナンスプロファイルの状況は、プロファイル内の準拠 API の割合に基づいています。

プロジェクトエラーは、Design Center API Designer テキストエディターページに表示されます。ページの ​[Project Errors (プロジェクトエラー)]​ セクションに、テキストエディターで開いている API 仕様の機能上の問題と準拠メッセージが表示されます。

すべての側面を含む API 全体。Anypoint Platform では、管理する製品のコンテキストでは API の側面が単に API と呼ばれることもあります。たとえば、Exchange では、API が API の仕様、ドキュメント、カタログを指す場合があります。API Designer では、API が API 仕様を指す場合があります。API カタログでは、API が API のインスタンス、ポリシー、コントラクトを指す場合があります。

API の各部。API の側面の例としては、仕様、インスタンス、カタログ情報、ドキュメントなどがあります。

API の機能と予期される動作、そして設計の基本理念やサポートされるデータ型などの詳細を定義します。API 仕様にはドキュメントと API 定義が含まれ、人間とソフトウェアが読むことのできるコントラクトを作成します。

API を機能させるための API 仕様の具現化。

API 実装のインスタンス化。API にはさまざまな環境やゲートウェイの複数のインスタンスを含めることができ、クライアントはこれらを使用して API コールを行うことができます。設定されていてもデプロイされていないインスタンスもこの側面の一部としてキャプチャされます。

コンシューマーが API について理解して使用するのに役立ち、例、ユースケース、チュートリアルなどのコンテンツが含まれています。

名前、バージョン、オーナー (コンタクト)、タグ、カテゴリなど、API カタログの API のエントリに関連したプロパティ。 Anypoint Platform では、これらのプロパティは Exchange の API アセットに関連付けられています。