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

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

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

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

ヘッダーにある[ライブドキュメンテーション]ボタン。

手順

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

タスクの結果

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

Petstore APIライブドキュメンテーションのスクリーンショット。

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

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

こちらにフィードバックをお寄せください