ドキュメントサイトの公開は、Quick Share機能の使用とは異なるよ。Quick Shareは内部や外部のパートナーと一時的に共有するためのリンクを生成するけど、長期的な使用を目的としていないんだ。それに対して、Publish Docs Sites機能はもっとしっかりしたカスタマイズが可能。ドメイン名やページデザイン、ナビゲーションなどを個別に設定できる。この機能は、公式サイトでAPIドキュメントを公開したいときに最適だよ。ドキュメントサイトを公開する#
デフォルトのメインサイトをクリックして、Publishボタン をクリックしてね。ドキュメントサイトの可視性設定#
Apidogのバージョンは2.6.39以上である必要があるよ。
Publishボタンをクリックした後、公開したドキュメントサイトの可視性を簡単にコントロールできる。Publish right nowボタンをクリックするだけで、サイトを公開できるよ。1.
Public: ドキュメントサイトはすべてのインターネットユーザーにアクセス可能になる。APIドキュメントをApidogが運営するAPI Hubで公開することもできるよ。 2.
Password protected: APIドキュメントをパスワードで保護したい場合は、Password protectedを有効にしてパスワードを設定しよう。自分で作成するか、ランダムに生成することができる。
3.
IP Allowlist: 特定のIPアドレスや範囲にアクセスを制限することができる。
4.
Email Allowlist: 設定したメールアドレ スの許可リストにあるメールのみが、認証コードを通じてドキュメントサイトにアクセスできる。メール許可リストはワイルドカードをサポートしているから、企業のメールアクセスを管理しやすいよ。
公開範囲#
デフォルトでは、ドキュメントの公開範囲はすべてのSharedリソースに設定されている。これをAPIsで設定できるよ。詳細は可視性設定を参照してね。リリース#
ドメイン#
Apidog提供のドメイン: ドキュメントにはデフォルトでApidogのサブドメインが付与される。例えば、https://vhh2uhkjv7.apidog.ioのようにね。手動で変更することもできる。すべてのApidogドキュメントはapidog.ioドメインを使用しているよ。
カスタマイズ#
APIドキュメントの外観やレイアウトをカスタマイズできるよ。基本情報#
Basic Infoに切り替えて、APIドキュメントのさまざまな基本オプションを設定できるよ。例えば：コンテンツ表示#
Content displayでは、APIドキュメントに表示するフィールドをカスタマイズできるよ。例えば：高度な設定#
ユーザーにアクセスさせたくない情報を隠すことができるよ。例えば：「Powered by Apidog」を隠す（プロフェッショナルプラン以上で利用可能）
「Run in Apidog」ボタンを隠す（プロフェッショナルプラン以上で利用可能）
レイアウトとナビゲーション#
高度な設定#
ドキュメント検索#
CORSプロキシ#
ブラウザのセキュリティ制限による問題を避けるために、CORSプロキシを指定できる。CORSプロキシについてもっと学ぶ。Google analytics#
API Hubへの公開#
API Hubにドキュメントを公開することもできる。これはApidogが運営するオープンプラットフォームで、APIの共有と探索に特化しているよ。プロジェクトがAPI Hubに公開されている場合、この説明がAPI Hubに表示されるよ。「Export」や「Clone」データを許可#
メインブランチでリリースされたドキュメントデータをエクスポートできる。ドキュメントリダイレクトルール#
URLが変更されたときにユーザーを正しいドキュメントに自動的にリダイレクトするルールを設定できる。これによりリンク切れを防ぎ、シームレスな体験を提供できるよ。URL & Slugルール#
複数のドキュメントサイトを公開する#
同じプロジェクト内で異なるチャネルにドキュメントを公開するために、公開中に追加のドキュメントサイトを作成できる。管理を簡単にするために、メインサイトの設定を各新しいサイトに複製できるよ。各サブサイトには独自のカスタムドメイン名を持たせることもできる。サブサイトのみが公開されたドキュメントの可視性範囲を設定でき、どのリソースが公開されるかを選択できる。 Modified at 2025-01-24 10:03:39
