第3章 Web コンソールを使用した Apicurio Registry コンテンツの管理

手順

1. Explore タブで、Apicurio Registry に保存されているアーティファクトのリストを参照するか、検索文字列を入力してアーティファクトを検索します。リストから選択して、名前、グループ、ラベル、グローバル ID などの特定の条件で検索できます。

   図3.1 Apicurio Registry Web コンソールのアーティファクト

   

2. アーティファクトをクリックすると、次の詳細が表示されます。

   • 概要: アーティファクト ID、名前、説明、ラベルなどのアーティファクトメタデータを表示します。また、アーティファクトコンテンツに対して設定できる有効性および互換性のルールも表示されます。
   • バージョン: すべてのアーティファクトバージョンのリストを表示します。アーティファクトの作成時に最初のバージョンをアップロードすることを選択しない限り、これは空になります。

   • ブランチ: アーティファクトのブランチのリストを表示します。これにより、少なくとも latest ブランチが表示されますが、設定によっては他の生成されたブランチが表示される場合もあります。

     図3.2 Apicurio Registry Web コンソールのアーティファクトの詳細

     

3. すべてのアーティファクトバージョンのリストを表示するには、Versions タブをクリックします。次に、リスト内のいずれかのバージョンをクリックするか、リスト内のバージョンの Action メニューから View Version を選択します。続いて、以下のアーティファクトバージョンの詳細が表示されます。

   • Overview: バージョン名、説明、グローバル ID、コンテンツ ID、ラベルなどのアーティファクトバージョンのメタデータを表示します。アーティファクトバージョンに対して作成されたコメントも表示されます。
   • Documentation (OpenAPI および AsyncAPI のみ): 自動生成された REST API ドキュメントを表示します。
   • Content: 完全なアーティファクトバージョンコンテンツの読み取り専用ビューを表示します。JSON コンテンツの場合、JSON または YAML をクリックして、好みの形式を表示できます。

   • References: このアーティファクトによって参照されるすべてのアーティファクトの読み取り専用ビューを表示します。View artifacts that reference this artifact version をクリックすることもできます。

     図3.3 Apicurio Registry Web コンソールのアーティファクトバージョンの詳細

     
4. アーティファクトの内容を my-openapi.json または my-protobuf-schema.proto などのローカルファイルに保存するには、Download をクリックします。