ライブドキュメンテーションを管理

ライブドキュメンテーションを有効化

自分のチーム外のユーザーとAPIドキュメンテーションを共有するためには、ライブドキュメンテーション機能を有効にする必要があります。

有効にするまでは、ヘッダーの[Live Documentation] (ライブドキュメンテーション)ボタンに示されているように、API定義にアクセスできるユーザーのみにプレビューとして表示されます。

[Settings] (基本設定)ページに移動します。
このページにアクセスするには、[Edit] (編集) > [Settings] (基本設定)に移動するか、左パネルの[Settings] (設定)をクリックします。
[Enabled] (有効)ボタンを[Off]から[On]に切り替えてURLを入力します。
可視性について選択します。[Password protected] (パスワード保護)を選択した場合は、対応するフィールドにパスワードを入力します。
[Save] (保存)をクリックしてライブドキュメンテーションを有効にします。

これでライブドキュメンテーションを利用できるようになります。[Open] (開く)をクリックすると、新しいタブで開きます。

APIドキュメンテーションを無効にし、そのサブドメインを保持するかどうか選択します。

APIを開き、 [Settings] (設定)に移動します。
[Enabled] (有効)ボタンを[On] (オン)から[Off] (オフ)に切り替えます。
ドキュメンテーションのサブドメインをリリースする場合は、[Retain Live API documentation subdomain] (ライブAPIドキュメンテーションのサブドメインを保持)チェックボックスをオフにします。
デフォルトでは、Talend Cloud API Designerはライブドキュメンテーションを有効にした時に定義されたサブドメインを保存します。これにより、後で再び有効にした時に同じURLを保持することができます。このサブドメインを別のAPIで使用する場合は、まずリリースする必要があります。
[Save] (保存)をクリックします。

ライブドキュメンテーションは無効にされています。サブドメインを保持した場合はいつでも再び有効にできます。保持しなかった場合、このサブドメインは別のAPIで使用できます。このドキュメンテーションを再び有効にする場合は、サブドメインを入力する必要があります。

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