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

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

手順

Talend Cloud API Designerを開き、API Portalタブに移動します。
[Configure the API Portal] (API Portalを設定)をクリックします。
[Select API Documentation to publish] (公開するAPIドキュメンテーションを選択)をクリックします。
[Api Portal]タブで、[Download] (ダウンロード)ボタンをクリックし、一つのAPIのドキュメンテーションをダウンロードしてファイルを保存します。
デフォルトでは、ZIPファイルに含まれるのは:
- ポータルに公開されるAPIドキュメンテーションを含むindex.mdファイル。
- OAS 3.0およびSwagger 2.0でAPI定義をそれぞれ含むopenapi30.jsonファイルとswagger20.jsonファイル。ユーザーは、ポータルからこれらのファイルをダウンロードできます。
[Settings] (設定)でダウンロードするAPI定義を選択できます。詳細は、ダウンロード可能なAPI定義の公開をご覧ください。
リポジトリーにあるファイルをapisフィルターに解凍します。
apisフォルダーには、各APIのフォルダーと各APIバージョンのサブフォルダーがあるはずです。
変更をコミットします。

リポジトリーにAPIをプッシュした結果、ポータルをデプロイできるようになりました。

このページまたはコンテンツに、タイポ、ステップの省略、技術的エラーなどの問題が見つかった場合は、お知らせください。改善に役立たせていただきます。