1.4. クライアント用の Apicurio Registry REST API
クライアントアプリケーションは、Core Registry API v3 を使用して、Apicurio Registry のスキーマと API アーティファクトを管理できます。この API は、次の機能の操作を提供します。
- 管理者
-
Apicurio Registry データを
.zipファイルにエクスポートまたはインポートし、実行時に Apicurio Registry インスタンスのログレベルを管理します。 - グループ
- Apicurio Registry 内のアーティファクトのグループを管理します。グループを作成して、アーティファクトをより適切に整理することができます。
- グループルール
- 特定のグループ内のスキーマまたは API アーティファクトのコンテンツの進化を管理するルールを設定して、無効または互換性のないコンテンツが Apicurio レジストリーに追加されるのを防ぎます。グループルールは、設定されているグローバルルールよりも優先されます。
- アーティファクト
- Apicurio Registry に保存されているスキーマと API アーティファクトを管理します。
- アーティファクトのメタデータ
- スキーマまたは API アーティファクトに関する詳細を管理します。アーティファクト名、説明、ラベルなどの詳細を編集できます。アーティファクトグループ、アーティファクトが作成または変更された時期などの詳細は読み取り専用です。
- アーティファクトルール
- 特定のスキーマまたは API アーティファクトのコンテンツの進化を管理するルールを設定して、無効または互換性のないコンテンツが Apicurio Registry に追加されないようにします。アーティファクトルールは、設定されているグループルールやグローバルルールをオーバーライドします。
- アーティファクトのバージョン
- スキーマまたは API アーティファクトのコンテンツを構成するバージョンのシーケンスを管理します。アーティファクトバージョンのライフサイクル状態: enabled、disabled、または deprecated を管理することもできます。
- グローバルルール
- 無効または互換性のないコンテンツが Apicurio Registry に追加されないようにするために、すべてのスキーマおよび API アーティファクトのコンテンツの進化を管理するルールを設定します。グローバルルールは、アーティファクトとそのグループにルールが設定されていない場合にのみ適用されます。
- 検索
- スキーマと API アーティファクトおよびバージョンを、名前、グループ、説明、ラベルなどで参照または検索します。
- システム
- Apicurio Registry のバージョンと、Apicurio Registry サーバーのリソース制限を取得します。
- ユーザー
- 現在の Apicurio Registry ユーザーを取得します。
他のスキーマレジストリー REST API との互換性
Apicurio Registry は、それぞれの REST API の実装を含めることで、次のスキーマレジストリーとの互換性も提供します。
- Apicurio Registry Core Registry API v2
- Confluent Schema Registry API v7
Confluent クライアントライブラリーを使用するアプリケーションは、ドロップインの代替として Apicurio Registry を使用できます。詳細は、Confluent Schema Registry の置換 を参照してください。