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

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

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

有効化されるまでは、API定義へのアクセス権を持つユーザーに対してのみ、プレビューとして閲覧可能です。

### 手順

1. [Edit] (編集) > [Open API settings] (Open APIの設定)をクリックして、APIの[Settings] (設定)ページに移動します。
2. [Enabled] (有効)ボタンを[Off]から[On]に切り替えてURLを入力します。

   ![ライブドキュメンテーションの設定。](https://help.qlik.com/talend/ja-JP/api-designer-user-guide/Resources/images/enable_live_doc_02_url.png)
3. 可視性について選択します。[Password protected] (パスワード保護)を選択した場合は、対応するフィールドにパスワードを入力します。
4. [Save] (保存)をクリックしてライブドキュメンテーションを有効にします。

### タスクの結果

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

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

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

### 手順

1. APIを開き、[Open API settings] (Open APIの設定)に移動します。
2. [Enabled] (有効)ボタンを[On] (オン)から[Off] (オフ)に切り替えます。
3. ドキュメンテーションのサブドメインをリリースする場合は、[Retain Live API documentation subdomain] (ライブAPIドキュメンテーションのサブドメインを保持)チェックボックスをオフにします。

   デフォルトでは、Talend Cloud API Designerはライブドキュメンテーションを有効にした時に定義されたサブドメインを保存します。これにより、後で再び有効にした時に同じURLを保持することができます。このサブドメインを別のAPIで使用する場合は、まずリリースする必要があります。 ![ライブドキュメンテーションの設定。](https://help.qlik.com/talend/ja-JP/api-designer-user-guide/Resources/images/disable_live_doc.png)
4. [Save] (保存)をクリックします。

### タスクの結果

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