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