5.2. Apicurio Registry Web コンソールを使用してアーティファクトを追加する

手順

1. Explore タブで Create artifact をクリックし、Create artifact ウィザードを完了します。

   注記

   コンテンツなしでプレースホルダーアーティファクトを作成できますが、Apicurio Registry はコンテンツタイプを自動的に検出できないため、アーティファクトタイプを指定する必要があります。プレースホルダーを作成すると、最初にルールを作成し、後でコンテンツを追加できます。

   1. Artifact Coordinates を指定して、Next をクリックします。

      • Group ID & Artifact ID: デフォルトの空の設定を使用して、アーティファクト ID を自動的に生成し、アーティファクトを default のアーティファクトグループに追加します。または、オプションのアーティファクトグループまたはアーティファクト ID を入力することもできます。
      • Type: デフォルトの Auto-Detect 設定を使用してアーティファクトタイプを自動的に検出するか (空のアーティファクトを作成する場合は許可されません)、リストからアーティファクトタイプを選択します (例: Avro Schema または OpenAPI)。自動検出できない Kafka Connect Schema アーティファクトタイプを手動で選択する必要があります。

   2. Artifact Metadata を指定して、Next をクリックします。

      • Name: 新しいアーティファクトの任意のわかりやすい名前を入力します。
      • Description: 新しいアーティファクトの任意の説明を入力します。
      • Labels: オプションで、新しいアーティファクトに 1 つ以上のラベル (名前と値のペア) を追加します。

   3. Version Content を指定して、Next をクリックします。

      • Version Number: 最初のバージョンを作成する場合は、任意のバージョン文字列を追加します。

      • コンテンツ: 次のいずれかのオプションを使用してコンテンツを指定します。

        • From file: Browse をクリックしてファイルを選択するか、ファイルをドラッグアンドドロップします。たとえば、my-openapi.json、my-schema.proto などです。または、テキストボックスにファイルの内容を入力することもできます。
        • From URL: 有効かつアクセス可能な URL を入力し、Fetch をクリックします。たとえば、https://petstore3.swagger.io/api/v3/openapi.json です。

   4. Version Metadata を指定します。

      • Name: オプションで、最初のアーティファクトバージョンのフレンドリーネームを入力します。
      • Description: オプションで、最初のアーティファクトバージョンの説明を入力します。
      • Labels: オプションで、最初のアーティファクトバージョンに 1 つ以上のラベル (名前と値のペア) を追加します。

2. Create をクリックして、アーティファクトの詳細を表示します。

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

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

     次の例は、Apache Avro アーティファクトの例を示しています。

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

     

     View larger image

     

3. Overview タブで、Edit 鉛筆アイコンをクリックして、名前や説明などのアーティファクトメタデータを編集します。

   分類や検索の目的で、0 個以上のラベル (名前 + 値) を追加することもできます。ラベルを追加するには、次の手順を実行します。

   1. Add label をクリックします。
   2. キー名と値を入力します (オプション)。
   3. 複数のプロパティーを追加するには、最初の 2 つの手順を繰り返します。
   4. Save をクリックします。
4. アーティファクトの内容を my-protobuf-schema.proto または my-openapi.json などのローカルファイルに保存するには、ページの最後にある Download をクリックします。

5. 新しいアーティファクトバージョンを追加するには、Versions タブに切り替えて、ツールバーの Create version をクリックします。次に、以下の情報を提供します。

   1. Version Number: オプションで、新しいバージョンのバージョン文字列を追加します。

   2. コンテンツ: 次のいずれかのオプションを使用してコンテンツを指定します。

      1. From file: Browse をクリックしてファイルを選択するか、ファイルをドラッグアンドドロップします。たとえば、my-openapi.json、my-schema.proto などです。または、テキストボックスにファイルの内容を入力することもできます。
      2. From URL: 有効かつアクセス可能な URL を入力し、Fetch をクリックします。たとえば、https://petstore3.swagger.io/api/v3/openapi.json です。
   3. これで、Create ボタンをクリックして新しいバージョンを作成できます。

6. アーティファクトを削除するには、ページヘッダーの Delete をクリックします。

   警告

   アーティファクトを削除すると、アーティファクトとそのバージョンがすべて削除され、元に戻すことはできません。