第3章 Web コンソールを使用した Apicurio Registry コンテンツの管理
Apicurio Registry Web コンソールを使用して、Apicurio Registry に保存されているスキーマと API アーティファクトを管理できます。これには、Apicurio Registry コンテンツのアップロードと参照、コンテンツのオプションルールの設定、およびクライアント SDK コードの生成が含まれます。
- 「Apicurio Registry Web コンソールを使用してアーティファクトを表示する」
- 「Apicurio Registry Web コンソールを使用してアーティファクトを追加する」
- 「Apicurio Registry Web コンソールを使用してコンテンツルールを設定する」
- 「Apicurio Registry Web コンソールを使用した OpenAPI アーティファクト用のクライアント SDK の生成」
- 「Apicurio Registry Web コンソールを使用したアーティファクト所有者の変更」
- 「Web コンソールを使用した Apicurio Registry インスタンス設定の設定」
- 「Apicurio Registry Web コンソールを使用したデータのエクスポートとインポート」
3.1. Apicurio Registry Web コンソールを使用してアーティファクトを表示する
Apicurio Registry Web コンソールを使用して、Apicurio Registry に保存されているスキーマと API アーティファクトを参照できます。本セクションでは、Apicurio Registry アーティファクト、グループ、バージョン、およびアーティファクトルールを表示する簡単な例を紹介します。
前提条件
- Apicurio Registry が環境にインストールされ、実行されている。
Apicurio Registry Web コンソールにログインしている。
http://MY_REGISTRY_URL/ui
- アーティファクトは、Web コンソール、コマンドライン、Maven プラグイン、または Java クライアントアプリケーションを使用して Apicurio Registry に追加されています。
手順
アーティファクト タブで、Apicurio Registry に保存されているアーティファクトのリストを参照するか、検索文字列を入力してアーティファクトを見つけます。リストから選択して、名前、グループ、ラベル、グローバル ID などの特定の条件で検索できます。
図3.1 Apicurio Registry Web コンソールのアーティファクト
アーティファクトをクリックすると、次の詳細が表示されます。
- Overview: アーティファクト名、アーティファクト ID、グローバル ID、コンテンツ ID、ラベル、プロパティーなどのアーティファクトバージョンメタデータを表示します。また、アーティファクトコンテンツに対して設定できる有効性および互換性のルールも表示されます。
- Documentaion (OpenAPI および AsyncAPI のみ): 自動生成された REST API ドキュメントを表示します。
- Content: 全アーティファクトコンテンツの読み取り専用ビューを表示します。JSON コンテンツの場合、JSON または YAML をクリックして、好みの形式を表示できます。
- References: このアーティファクトによって参照されるすべてのアーティファクトの読み取り専用ビューを表示します。View artifacts that reference this artifact クリックすることもできます。
- このアーティファクトの追加バージョンが追加されている場合は、ページヘッダーの Version リストから選択できます。
-
アーティファクトの内容を
my-openapi.json
またはmy-protobuf-schema.proto
などのローカルファイルに保存するには、ページの最後にある Download をクリックします。