ドキュメントサイト設定
ドキュメントサイトの公開は、「クイック共有」機能の使用とは異なります。クイック共有は内部および外部のパートナー向けに共有可能なリンクを生成し、一時的なコミュニケーション手段として使用されますが、長期的な使用を目的としていません。
これに対して、「ドキュメントサイト」機能は、より高度なカスタマイズを可能にします。この機能を使用すると、ドメイン名、ページデザイン、ナビゲーションなどを個別に設定することができ、公式ウェブサイトでAPIドキュメントを公開する際に最適です。
ドキュメントサイトの公開
デフォルトのメインサイトをクリックし、次に「公開」ボタンをクリックします。
API Hub（Apidogが運営するオープンプラットフォーム）でドキュメントを公開することを選択できます。これはAPIの共有と探索を目的としたプラットフォームです。
ドキュメントにパスワードを設定するには、「パスワード保護」を選択し、希望するパスワードを入力して、「今すぐ公開」をクリックすると、ドキュメントサイトが公開されます。
以下の画像に示されているように、環境を設定することができます。これにより、読者は提供された環境を使用してAPIを簡単にデバッグできるようになります。
公開範囲
デフォルトでは、ドキュメントの公開範囲は「共有」に設定されています。これを「全てのAPI」で構成することができます。詳細については可視性設定を参照してください。
複数のAPIバージョンを持つドキュメントサイトの公開
複数のAPIバージョンを公開するには、「リリースバージョン」機能を使用します。詳細については、APIバージョニングをご参照ください。
複数のドキュメントサイトを公開
同じプロジェクト内で異なるチャネルにドキュメントを公開するには、公開中に追加のドキュメントサイトを作成できます。管理を簡単にするために、新しいサイトごとにメインサイトの設定を複製することができます。また、各サブサイトにはユニークなカスタムドメイン名を設定することも可能です。
サブサイトのみが公開されたドキュメントの可視性範囲を設定でき、どのリソースを公開するかを選択することができます。
