1. Homepage
  2. API Governance

  3. カスタムガバナンスルールセットの作成

カスタムガバナンスルールセットの作成

MuleSoft は、「Anypoint API Best Practices (Anypoint API ベストプラクティス)」、「OpenAPI Best Practices (OpenAPI ベストプラクティス)」、「Authentication Security Best Practices (認証セキュリティベストプラクティス)」、「Mule API Management Best Practices (Mule API 管理ベストプラクティス)」など、Exchange でいくつかのルールセットを提供しています。​[Rulesets (ルールセット)]​ 種別で検索を絞り込んで、Exchange のルールセットを発見できます。​「アセットの検索」​を参照してください。

ルールセットは、メタデータドキュメントを管理するためのオープンソースフレームワークである AMF を使用して実装されます。AMF は、API モデルの組み込み機能を備えた任意のメタデータモデルの解析、変換、検証、表示に使用されます。Anypoint Platform は AMF を使用して、RAML、OAS、AsyncAPI、GraphQL API 仕様を解析します。

提供されているルールセット以外のルールセットが必要な場合は、独自のカスタムルールセットを作成できます。

始める前に

独自のルールを作成することで、組織固有の規制や標準に従って API を管理できます。ルールセットのカスタマイズを開始する前に、時間をかけてルールセット開発 CLI コマンドとルールセット言語の概念を理解します。

今後のリリースで MuleSoft による提供を希望するルールセットのアイデアを MuleSoft アイデアポータル​に登録することもできます。

始める準備ができたら、次の手順を実行します。

  1. ルールセットで API を検証する方法の簡単な概要について、 「Custom Validation (カスタム検証)」​を参照します。

  2. 既存のルールセットに基づかない完全に新しいカスタムルールセットを作成する場合は、 「AMF Rulesets (AMF ルールセット)」チュートリアル​に従ってルールセット開発 CLI をインストールします。

  3. Anypoint CLI をインストールします。これは、カスタムルールセットを検証し、そのドキュメントを生成し、Exchange にパブリッシュするために必要になります。

カスタムルールセットを作成する

カスタムルールセットを作成するには、次のいずれかのアプローチを使用します。

カスタムルールセットを変更または作成したら、ルールセットが正しくコーディングされていることを検証し、ドキュメントを生成して、Exchange にパブリッシュする必要があります。カスタムルールセットの検証とパブリッシュを参照してください。

関連情報