メイン コンテンツをスキップする 補完的コンテンツへスキップ

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

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

手順

  1. Talend Cloud API Designerを開き、API Portalタブに移動します。
  2. [Configure the API Portal] (API Portalを設定)をクリックします。
  3. [Select API Documentation to publish] (公開するAPIドキュメンテーションを選択)をクリックします。
    API Portal設定ページ。
  4. [Api Portal]タブで、[Download] (ダウンロード)ボタンをクリックし、一つのAPIのドキュメンテーションをダウンロードしてファイルを保存します。
    デフォルトでは、ZIPファイルに含まれるのは:
    • ポータルに公開されるAPIドキュメンテーションを含むindex.mdファイル。
    • OAS 3.0およびSwagger 2.0でAPI定義をそれぞれ含むopenapi30.jsonファイルとswagger20.jsonファイル。ユーザーは、ポータルからこれらのファイルをダウンロードできます。

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

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

タスクの結果

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

このページは役に立ちましたか?

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