第2章 Apicurio Registry のコンテンツルール

ルールは、コンテンツが Apicurio Registry に追加された場合のみ、適用されます。これには、以下の REST 操作が含まれます。

ルールに違反した場合、Apicurio Registry は HTTP エラーを返します。応答本文には、違反したルールと、何が問題だったのかを示すメッセージが含まれます。

アーティファクト固有ルールとグローバルルールの優先順位は次のとおりです。

各ルールには、名前と設定情報があります。Apicurio Registry は、各アーティファクト、各グループのルールのリストと、グローバルルールのリストを管理します。リスト内の各ルールは、ルール実装の名前と設定で構成されます。

ルールが実行されると、アーティファクトの現在のバージョン (存在する場合) の内容と、追加されるアーティファクトの新しいバージョンが提供されます。ルールの実装は、アーティファクトがそのルールに合格するかどうかに応じて、合格または失敗のいずれかを返します。そうでない場合、Apicurio Registry は HTTP エラー応答で理由を報告します。一部のルールは、コンテンツの以前のバージョンを使用しない場合があります。たとえば、互換性ルールは以前のバージョンを使用しますが、構文またはセマンティック妥当性ルールは使用しません。

管理者は、Apicurio Registry のグローバルルール、グループ固有ルール、およびアーティファクト固有ルールを設定できます。開発者は、グループ固有およびアーティファクト固有ルールのみを設定できます。

Apicurio Registry は、特定のアーティファクト用に設定されたルールを適用します。そのレベルでルールが設定されていない場合、Apicurio Registry はグループ固有ルールを適用します。グループレベルでルールが設定されていない場合、Apicurio Registry はグローバルに設定されたルールを適用します。グローバルルールが設定されていない場合は、ルールは適用されません。

グループとアーティファクト固有ルールを設定する

Apicurio Registry Web コンソールまたは REST API を使用して、グループ固有およびアーティファクト固有ルールを設定できます。詳細は以下を参照してください。

グローバルルールの設定

管理者は、いくつかの方法でグローバルルールを設定できます。

apicurio.rules.global.<ruleName>

apicurio.rules.global.<ruleName>

現在、以下のルール名がサポートされています。

application プロパティーの値は、設定されたルールに固有の有効な設定オプションである必要があります。