APIドキュメンテーションのライブプレビューを生成します。
手順
-
Talend Cloud API DesignerでAPI定義を開きます。
-
左パネルの上部で[Settings] (設定)をクリックします。
-
[LIVE DOCUMENTATION] (ライブドキュメンテーション)セクションで[Enabled] (有効化)ボタンを[On] (オン)に切り替えます。
-
ドキュメンテーションのURLを入力します。
ドキュメンテーションURLは一意であることが必要です。たとえば、moviecatalog-<勤務先の会社名>と入力します。
-
ドキュメンテーションの[Visibility] (表示)を選択(たとえば[Public] (パブリック))します。
-
[Save] (保存)をクリックします。
タスクの結果
これでライブドキュメンテーションが有効になり、定義したURLでどのユーザーも利用できるようになります。