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