3.2. API ドラフトの作成

手順

1. Apicurio Studio Web コンソールで、Create draft をクリックします。

2. ウィザードを完了し、新規ドラフトの次の詳細を指定します。

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

      • Group ID & Draft ID: デフォルトの空の設定を使用して Draft ID を自動生成し、ドラフトを default Draft グループに追加します。または、オプションの Group ID または Draft ID を入力することもできます。
      • Version number: オプションでバージョン番号を指定します。
      • Type: デフォルトの Auto-Detect 設定を使用してドラフトタイプを自動的に検出する (空のドラフトを作成する場合は許可されません) か、リストからドラフトタイプ (OpenAPI など) を選択します。

   2. Draft Content を指定し、Next をクリックします。

      • From template: テンプレートリストから選択します。

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

   3. Draft Metadata を指定します。

      • Name: オプションで、最初のアーティファクトバージョンのフレンドリーネームを入力します。
      • Description: オプションで、最初のアーティファクトバージョンの説明を入力します。
3. Create をクリックしてドラフトを作成します。ドラフトの詳細ビューが表示されます。

4. ドラフトを編集するには、Edit draft をクリックします。

   1. Design タブをクリックし、必要に応じて以下のようにドラフトを編集します。

      • バージョン番号と説明を入力します。
      • (AsyncAPI のみ) サービス条件を定義します。
      • 連絡先情報 (名前、メールアドレス、URL) を追加します。
      • ライセンスを選択します。
      • (OpenAPI のみ) タグを定義します。
      • サーバーを 1 つ以上定義します。
      • セキュリティースキームを設定します。
      • (OpenAPI のみ) セキュリティー要件を指定します。
      • (OpenAPI のみ) ベンダーエクステンションを設定します。
   2. Source タブをクリックして、ドラフトのライブプレビューを確認します。エディターページで値を編集すると、Source タブの内容が自動的に更新されます。
   3. (オプション) 最後に保存してから加えた変更を表示するには、Actions > Show draft changes をクリックします。

   4. (オプション) ドラフトエディターの左ペインで、以下の項目を追加できます。

      • (OpenAPI のみ) リソースパス、データタイプ、レスポンス
      • (AsyncAPI のみ) チャネル、データタイプ、メッセージ、オペレーショントレイト、メッセージトレイト
   5. Save をクリックします。
   6. ブレッドクラムを使用して、Drafts ページに戻ります。