APIドキュメンテーションをダウンロード

ポータルに公開するAPIドキュメンテーションとAPI定義をダウンロードします。

1. Talend Cloud API Designerを開き、API Portalタブに移動します。
2. [Configure the API Portal] (API Portalを設定)をクリックします。
3. [Select API Documentation to publish] (公開するAPIドキュメンテーションを選択)をクリックします。

   

4. [Api Portal]タブで、[Download] (ダウンロード)ボタンをクリックし、一つのAPIのドキュメンテーションをダウンロードしてファイルを保存します。
   デフォルトでは、ZIPファイルに含まれるのは:

   • ポータルに公開されるAPIドキュメンテーションを含むindex.mdファイル。
   • OAS 3.0およびSwagger 2.0でAPI定義をそれぞれ含むopenapi30.jsonファイルとswagger20.jsonファイル。ユーザーは、ポータルからこれらのファイルをダウンロードできます。

   [Settings] (設定)でダウンロードするAPI定義を選択できます。詳細については、 ダウンロード可能なAPI定義の公開をご覧ください。

   

5. リポジトリーにあるファイルをapisフィルターに解凍します。
   apisフォルダーには、各APIのフォルダーと各APIバージョンのサブフォルダーがあるはずです。
6. 変更をコミットします。