1. Homepage
  2. API Governance

  3. 指定された API へのガバナンスルールセットの適用

指定された API へのガバナンスルールセットの適用

管理する API を Exchange で識別したら、ガバナンスプロファイルを追加します。ガバナンスプロファイルを使用すれば、各セットのルールセットで管理する特定の API のセットを絞り込むことができます。

API Governance 管理者と組織のシステム管理者のみがプロファイルを作成、編集、削除できます。

API Governance コンソールを使用してガバナンスプロファイルを作成する

API Governance コンソール UI の手順に従って、プロファイルを作成します。

検索条件を選択しない場合、ガバナンスプロファイルは Exchange の​すべて​の API に適用されます。

  • より少ないルールセットを選択し、検索条件を追加して、単一プロファイルのスコープを絞り込みます。

  • メンテナンスを容易にするために、関連する API セットを管理するように各プロファイルを設定します。

  • API Governance に慣れ、組織にガバナンスプロセスを確立する前に、いくつかの API の管理から始めます。
API Governance コンソールを使用してガバナンスプロファイルを作成する手順は、次のとおりです。

  1. API Governance​ で、​[New Profile (新規プロファイル)]​ をクリックします。

  2. UI プロンプトに従って、次の情報を入力します。

Select Rulesets (ルールセットの選択)

API の管理に使用する 1 つ以上のルールセットを選択します。

検索ボックスと検索条件を使用して、使用するルールセットを検索します。次の要素でルールセットを絞り込むことができます。

  • 組織

  • Tag (タグ)

  • Category (カテゴリ)

使用する各ルールセットのバージョンを選択するか、​[Latest (最新)]​ オプションを選択できます。デフォルトは ​[Latest (最新)]​ です。

  • [Latest (最新)]​ を選択した場合、プロファイルの保存後に何らかのバージョンがパブリッシュされると、プロファイルで自動的にそのルールセットの最新バージョンが使用されます。これにより、このプロファイルで選択された API が常に最新バージョンのルールセットに対して検証され、手動でプロファイルを更新する必要がなくなります。

  • 特定のバージョンを選択した場合、プロファイルの保存後にルールセットの新しいバージョンがパブリッシュされても、プロファイルでそのバージョンが引き続き使用されます。これにより、特定のルールセットのバージョンに準拠する、このプロファイルで選択した API が、新しくパブリッシュされたバージョンのルールセットによって誤って準拠しなくなることを回避できます。ルールセットの新しいバージョンを使用する準備ができたら、プロファイルを更新して新しいバージョンを選択できます。

Define Filter Criteria (検索条件の定義)

選択したルールセットを特定の API に適用するには、検索条件を選択します。検索条件は、Exchange にある組織の API と、Exchange に追加したときの新規 API に適用されます。

検索条件を適用すると、絞り込まれた API のプレビューが ​[Define Filter Criteria (検索条件の定義)]​ ページに表示されます。これはいくつかの API に制限され、検索できません。プロファイルを保存したら、そのプロファイルの管理された API のリストを表示および検索できます。

[General (一般)]​ 検索条件:

  • API Types (API 種別)

  • タグ

    Exchange で最もよく使用されるタグとプロファイルに追加したタグが ​[Tags (タグ)]​ セクションにリストされます。​「ガバナンスプロファイルでのタグの選択および追加」​を参照してください。

  • カテゴリ

    選択コンテンツは、Exchange の API にカテゴリが含まれる場合にのみ、​[Categories (カテゴリ)]​ セクションに表示されます。

    複数のタグやカテゴリで絞り込む場合、API が条件に一致するには選択したすべてのタグやカテゴリが含まれている必要があります。​「管理する API の識別」​を参照してください。

    カテゴリで絞り込むと、各 API のカテゴリ数が表示され、これは ​[Categories (カテゴリ)]​ に続いて括弧に入った数で示されます。​[Categories (カテゴリ)]​ にマウスポインターを置くと、詳細が表示されます。

[API Instance (API インスタンス)]​ 検索条件:

  • Include only APIs with instances (インスタンスを含む API のみを含める)

    • Environment Type (環境種別)

    • Environment Name (環境名)

[API Instance (API インスタンス)]​ 検索条件の ​[Include only APIs with instances (インスタンスを含む API のみを含める)]​ を選択した場合、API Manager にインスタンスがある仕様のみが含まれます。その後、必要に応じて環境種別と環境名で絞り込むことができます。

Set Notifications (通知の設定)

: このプロファイルの自動通知を有効または無効にします。デフォルトは有効です。​「準拠通知の送信」​を参照してください。

Specify General Information (一般情報の指定)

プロファイル名と説明を入力して、他のユーザーがこのプロファイルに含まれているガバナンスルールセットの種類、およびこのプロファイルで検証されている API の種類を理解できるようにします。

Review (確認)

: プロファイルを確認して ​[Create (作成)]​ をクリックします。

API Governance コンソールを使用してガバナンスプロファイルを更新する

API Governance コンソールの手順に従って、プロファイルを更新します。

API Governance コンソールを使用してガバナンスプロファイル情報を更新する手順は、次のとおりです。

  1. API Governance​ コンソールの ​[Profiles (プロファイル)]​ タブを選択します。

  2. 更新するプロファイルで、その他のオプションメニューアイコン (​overflow menu icon​) をクリックし、​[Edit (編集)]​ を選択します。

  3. [Next (次へ)]​ ボタンと ​[Previous (前へ)]​ ボタンを使用して UI を移動し、必要に応じてプロファイル情報を更新します。オプションについての詳細は、「​API Governance コンソールを使用してガバナンスプロファイルを作成する​」を参照してください。

  4. 変更を確認して、​[Update Profile (プロファイルを更新)]​ をクリックします。

編集を適用すると、API 総数が更新され、更新された検索条件に基づいてガバナンスプロファイルに含まれる API の数が示されます。

API Governance コンソールを使用してガバナンスプロファイルを削除する

API Governance コンソールの手順に従って、プロファイルを削除します。

ガバナンスプロファイルを削除する手順は、次のとおりです。

  1. API Governance​ コンソールの ​[Profiles (プロファイル)]​ タブで、更新するプロファイルの最後にあるその他のオプションメニューアイコン (​overflow menu icon​) をクリックし、​[Delete (削除)]​ を選択します。

  2. [Yes, Delete (はい、削除します)]​ をクリックします。

API Governance CLI を使用してガバナンスプロファイルを作成する

コマンドを使用して API Governance プロファイルを作成するには、次のコマンドを使用します。

governance:profile:create

> governance:profile:create [フラグ] <profile-name> <ruleset-asset-identifiers>

このコマンドは、​profile-name​ で指定された新しいガバナンスプロファイル名の文字列値を使用して、ガバナンスプロファイルを作成します。

ruleset-asset-identifiers​ を含める必要があります。これは、ルールセットアセット識別子のカンマ区切りのリストであり、それぞれが Exchange 内の各アセットを一意に識別するグループ ID、アセット ID、およびバージョン (GAV) です。例: <group_id>/<asset_id>/<version>,<group_id>/<asset_id>/<version>​。ここで、​<version>​ は ​latest​ の特定のバージョンです。バージョンとして ​latest​ を使用する場合、プロファイルの作成後にバージョンがパブリッシュされると、プロファイルはルールセットの最新バージョンを自動的に使用します。​Exchange アセット識別子 (GAV) を取得する​を参照してください。

notify​ フラグの 1 つを使用して、作成中のプロファイルの通知を設定できます。​notify​ フラグを使用しない場合、コマンドによって通知は設定されません。通知はデフォルトでオフになっています。

このコマンドでは、デフォルトのフラグ以外に次のフラグも受け入れます。

フラグ 説明

--criteria <filtertype:filtervalue>,…​

検索条件を適用して、プロファイルルールセットが適用される API のリストを選択できます。カンマ区切りの検索条件のリストを指定します。各検索条件の種別と値は、​filtertype:filtervalue​ の形式です。

次のような検索条件を使用できます。

  • scope​: API 種別、​rest-api​ または ​async-api​

  • tag​: Exchange で API に対して定義されたタグ

  • category​: Exchange で API に対して定義されたカテゴリ。検索条件値は ​categoryName:value​ として 2 つの部分で指定されます。

  • env-type​: 環境種別 (すべて、本番、または Sandbox)

  • env-id​: API Manager の環境名の ID。​[API Manager]​ > ​[Environment information (環境情報)]​ を使用してこの値を取得できます。​「環境の概念の確認」​を参照してください。

    env-type​ または ​env-id​ が使用されている場合、プロファイルに ​[API Instance (API インスタンス)]​ 検索条件が設定されるため、インスタンスが設定された API のみが絞り込まれます。

    CLI を使用してプロファイルの ​[API Instance (API インスタンス)]​ を選択解除するには、​env-type​ も ​env-id​ も含まれない ​--criteria​ フラグを使用してプロファイルを更新します。

例: tag:tag1,category:category1:value,category:category2:value2,scope:rest-api,scope:async-api,env-type:production

--description <description>

description​ フラグの後には、新しいガバナンスプロファイルの説明である文字列が続きます。

--notify-contact

通知を有効にし、受信者を API に設定された取引先責任者に設定します。

--notify-publisher

通知を有効にし、受信者を API パブリッシャーに設定します。

--notify-others <email ID,email ID,…​>

通知を有効にし、受信者を指定されたメール ID のリストに設定します。

コマンド例:

anypoint-cli-v4 governance:profile:create "OAS Best Practices" 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1 --criteria "tag:oas,category:API Type:Experience API,scope:rest-api" --description "Profile for OAS Best Practices"

anypoint-cli-v4 governance:profile:create "Open API Best Practices" 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1 --criteria "tag:oas,category:API Type:Experience API,scope:rest-api" --description "Profile for OAS Best Practices"

anypoint-cli-v4 governance:profile:create "Anypoint Best Practices" 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-api-best-practices/1.0.1 --criteria "tag:raml tag:oas category:API Type:Experience API,scope:rest-api" --description "Profile for REST API Best Practices" --notify-publisher  --notify-contact --notify-others a@a.a,b@b.com

anypoint-cli-v4 governance:profile:create "Primary API Standards" 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/latest,68ef9520-24e9-4cf2-b2f5-620025690913/myorg-best-practices/1.0.2 --criteria "tag:prim,category:API Type:Experience API,scope:rest-api" --description "Profile for Primary API Standards"

出力例:

 Profile Added
 Id         	4f98e59d-8efb-420f-ac95-9cd0af15bd45
 Name       	OAS Best Practices
 Description	Profile for OAS Best Practices
 Rulesets   	gav://68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1
 Filter     	tag:best

API Governance CLI を使用してガバナンスプロファイル情報をリストする

コマンドを使用してすべてのガバナンスプロファイルのガバナンスプロファイル情報をリストするには、次のコマンドを使用します。

governance:profile:list

> governance:profile:list [フラグ]

このコマンドは、組織のすべてのガバナンスプロファイルの情報をリストします。ガバナンスプロファイルを更新するときに、この情報が必要です。

このコマンドでは、デフォルトのフラグ以外に次のフラグも受け入れます。

フラグ 説明

--output <output-format>

コマンド出力の形式。サポートされている値は、​table​ (デフォルト) および ​json​ です。

コマンド例:

anypoint-cli-v4 governance:profile:list

出力例:

Profile Name                 	Profile Id

Minimum Security Requirements	1f418cf4-b870-4b31-8734-f55f28d45f8f
Best Practices               	19fb211b-8775-43cc-865a-46228921d6ed
New Best Practices           	4eaf9176-3ef9-4021-a67c-6e4bc10d3763
OAS Standards                	51ae8795-2278-407e-942f-becba29af986

API Governance CLI を使用して特定のガバナンスプロファイル情報をリストする

コマンドを使用して特定のガバナンスプロファイル ID のガバナンスプロファイル情報をリストするには、次のコマンドを使用します。

governance:profile:info

> governance:profile:info [フラグ] <profile-id>

このコマンドは、ガバナンスプロファイル ID のすべての情報をリストします。

このコマンドでは、デフォルトのフラグ以外に次のフラグも受け入れます。

フラグ 説明

--output <output-format>

コマンド出力の形式。サポートされている値は、​table​ (デフォルト) および ​json​ です。

コマンド例:

anypoint-cli-v4 governance:profile:info 19fb211b-8775-43cc-865a-46228921d6ed

出力例:

Id         	        19fb211b-8775-43cc-865a-46228921d6ed
Name       	        Best Practices
Description	        Best Practices Profile
Rulesets   	        68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.0 8a840abd-e63a-4f8b-87ab-24052eda2017/best-practices-ruleset/1.0.0 68ef9520-24e9-4cf2-b2f5-620025690913/required-examples/1.0.0
Criteria   	        tag:best,category:API Type:Experience API,scope:rest-api
NotificationConfig  Contact,Publisher

API Governance CLI を使用してガバナンスプロファイルを更新する

コマンドを使用してガバナンスプロファイルを更新するには、次のコマンドを使用します。

governance:profile:update

> governance:profile:update [フラグ] <profile-id>

このコマンドは、​profile-id​ で指定されるガバナンスプロファイルを更新します。 この ID を取得するには、​governance:profile:info​ または ​governance:profile:list​ コマンドを実行します。

ガバナンスプロファイルの一般情報、ルールセット、検索条件、および通知設定を更新できます。​notify​ フラグの 1 つを使用して、通知設定を更新したり、通知を無効にしたりできます。すべての変更で、既存の通知設定が上書きされます。​notify​ フラグを使用しない場合、通知設定は変更されません。

このコマンドでは、デフォルトのフラグ以外に次のフラグも受け入れます。

フラグ 説明

--profile-name <profile-name>

profile-name​ フラグの後には、新しいガバナンスプロファイル名である文字列が続きます。

--ruleset-gavs <ruleset-gavs>

ruleset-gavs​ フラグの後には、各ルールセットのアセット識別子の ​<group_id>/<asset_id>/<version>,<group_id>/<asset_id>/<version>​ 形式のリストが続きます。ここで、​<version>​ は特定のバージョンまたは ​latest​ です。アセット識別子は、Exchange 内の各アセットを識別する一意のグループ ID、アセット ID、およびバージョン (GAV) です。バージョンとして ​latest​ を使用する場合、プロファイルの作成後にバージョンがパブリッシュされると、プロファイルはルールセットの最新バージョンを自動的に使用します。

Exchange アセット識別子 (GAV) を取得する​を参照してください。

--criteria <filtertype:filtervalue>,…​

検索条件を適用して、プロファイルルールセットが適用される API のリストを選択できます。カンマ区切りの検索条件のリストを指定します。各検索条件の種別と値は、​filtertype:filtervalue​ の形式です。

次のような検索条件を使用できます。

  • scope​: API 種別、​rest-api​ または ​async-api​

  • tag​: Exchange で API に対して定義されたタグ

  • category​: Exchange で API に対して定義されたカテゴリ。検索条件値は ​categoryName:value​ として 2 つの部分で指定されます。

  • env-type​: 環境種別 (すべて、本番、または Sandbox)

  • env-id​: API Manager の環境名の ID。​[API Manager]​ > ​[Environment information (環境情報)]​ を使用してこの値を取得できます。​「環境の概念の確認」​を参照してください。

    env-type​ または ​env-id​ が使用されている場合、プロファイルに ​[API Instance (API インスタンス)]​ 検索条件が設定されるため、インスタンスが設定された API のみが絞り込まれます。

    CLI を使用してプロファイルの ​[API Instance (API インスタンス)]​ を選択解除するには、​env-type​ も ​env-id​ も含まれない ​--criteria​ フラグを使用してプロファイルを更新します。

例: tag:tag1,category:category1:value,category:category2:value2,scope:rest-api,scope:async-api,env-type:production

--description <description>

description​ フラグの後には、新しいガバナンスプロファイルの説明である文字列が続きます。

--notify-off

通知を無効にします。

--notify-contact

通知を有効にし、受信者を API に設定された取引先責任者に設定します。

--notify-publisher

通知を有効にし、受信者を API パブリッシャーに設定します。

--notify-others <email ID,email ID,…​>

通知を有効にし、受信者を指定されたメール ID のリストに設定します。

コマンド例:

anypoint-cli-v4 governance:profile:update 4eaf9176-3ef9-4021-a67c-6e4bc10d3763 --profile-name "MyOrg Best Practices"

anypoint-cli-v4 governance:profile:update 19fb211b-8775-43cc-865a-46228921d6ed --criteria `tag:best,category:API Type:Experience API,scope:rest-api`

anypoint-cli-v4 governance profile update 67eff44a-28a3-43d4-93d9-bddedb92c711 --notify-publisher  --notify-contact --notify-others a@a.a,b@b.com

anypoint-cli-v4 governance profile update 67eff44a-28a3-43d4-93d9-bddedb92c711 --notify-off

anypoint-cli-v4 governance profile update 19fb211b-8775-43cc-865a-46228921d6ed --criteria `tag:best,category:API Type:Experience API,scope:rest-api,env-type:production` --ruleset-gavs 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/latest,68ef9520-24e9-4cf2-b2f5-620025690913/myorg-best-practices/latest

出力例:

 Profile updated 51f9f94c-fb0c-43d4-9895-22c9e64f1537

Exchange アセット識別子 (GAV) を取得する

Exchange アセットの GAV を取得するには、次の操作を実行します。

  • Exchange CLI を使用している場合、​exchange:asset:list​ コマンドを実行します。

  • Exchange Web UI を使用している場合、Exchange でアセットを選択し、URL からグループ ID とアセット ID をコピーします。次に、表示しているバージョンのバージョンノードを追加します。たとえば、Exchange の「OpenAPI Best Practices (OpenAPI ベストプラクティス)」ルールセットの GAV は ​68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1​ です。

API Governance CLI を使用してガバナンスプロファイルを削除する

CLI を使用してガバナンスプロファイルを削除するには、次のコマンドを使用します。

governance:profile:delete

> governance:profile:delete [フラグ] <profile-id>

このコマンドは、​profile-id​ によって指定された特定のガバナンスプロファイルを削除します。 この ID を取得するには、​governance:profile:info​ または ​governance:profile:list​ コマンドを実行します。

governance:profile:delete​ コマンドでは、デフォルトのフラグのみを受け入れます。

コマンド例:

anypoint-cli-v4 governance:profile:delete 8ffd463f-86b2-4132-afc6-44d179209362

出力例:

 Profile with id 8ffd463f-86b2-4132-afc6-44d179209362 removed

関連情報