APIのライブドキュメンテーションの有効化 - Cloud

Talend Cloud API Services Platform入門ガイド

Version
Cloud
Language
日本語 (日本)
Product
Talend Cloud
Module
Talend API Designer
Talend API Tester
Talend Management Console
Talend Studio
Content
ジョブデザインと開発

APIドキュメンテーションのライブプレビューを生成します。

手順

  1. Talend Cloud API DesignerでAPI定義を開きます。
  2. 左パネルの上部で[Settings] (設定)をクリックします。
  3. [LIVE DOCUMENTATION] (ライブドキュメンテーション)セクションで[Enabled] (有効化)ボタンを[On] (オン)に切り替えます。
  4. ドキュメンテーションのURLを入力します。
    ドキュメンテーションURLは一意であることが必要です。たとえば、moviecatalog-<勤務先の会社名>と入力します。
  5. ドキュメンテーションの[Visibility] (表示)を選択(たとえば[Public] (パブリック))します。
  6. [Save] (保存)をクリックします。

タスクの結果

これでライブドキュメンテーションが有効になり、定義したURLでどのユーザーも利用できるようになります。