ドキュメントサイトの公開

ドキュメントサイトの公開は、Quick Share機能の使用とは異なるよ。Quick Shareは内部や外部のパートナーと一時的に共有するためのリンクを生成するけど、長期的な使用を目的としていないんだ。

それに対して、Publish Docs Sites機能はもっとしっかりしたカスタマイズが可能。ドメイン名やページデザイン、ナビゲーションなどを個別に設定できる。この機能は、公式サイトでAPIドキュメントを公開したいときに最適だよ。

ドキュメントサイトを公開する

デフォルトのメインサイトをクリックして、Publishボタンをクリックしてね。

ドキュメントサイトの可視性設定

Apidogのバージョンは2.6.39以上である必要があるよ。

Publishボタンをクリックした後、公開したドキュメントサイトの可視性を簡単にコントロールできる。Publish right nowボタンをクリックするだけで、サイトを公開できるよ。

利用可能な可視性設定:

Public: ドキュメントサイトはすべてのインターネットユーザーにアクセス可能になる。APIドキュメントをApidogが運営するAPI Hubで公開することもできるよ。

Password protected: APIドキュメントをパスワードで保護したい場合は、Password protectedを有効にしてパスワードを設定しよう。自分で作成するか、ランダムに生成することができる。

password protected API documentation.png

IP Allowlist: 特定のIPアドレスや範囲にアクセスを制限することができる。

Email Allowlist: 設定したメールアドレスの許可リストにあるメールのみが、認証コードを通じてドキュメントサイトにアクセスできる。メール許可リストはワイルドカードをサポートしているから、企業のメールアクセスを管理しやすいよ。

公開範囲

デフォルトでは、ドキュメントの公開範囲はすべてのSharedリソースに設定されている。これをAPIsで設定できるよ。詳細は可視性設定を参照してね。

リリース

APIドキュメントの複数のバージョンを作成して公開できる。APIバージョンの公開についてもっと学ぶ。

release settings for API Documentations.jpg

ドメイン

Apidog提供のドメイン: ドキュメントにはデフォルトでApidogのサブドメインが付与される。例えば、https://vhh2uhkjv7.apidog.ioのようにね。手動で変更することもできる。すべてのApidogドキュメントはapidog.ioドメインを使用しているよ。

カスタムドメイン: Apidogドキュメントを自分のドメインにバインドできる。カスタムドメインについてもっと学ぶ。

domain settings for API documentations.jpg

カスタマイズ

APIドキュメントの外観やレイアウトをカスタマイズできるよ。

customize appearance and layouts for API documentation.png

外観

基本情報

Basic Infoに切り替えて、APIドキュメントのさまざまな基本オプションを設定できるよ。例えば：

タイトル

ロゴ

ファビコン

メインカラー

言語

ライト/ダークモード

コンテンツ表示

content display for API documentation.png

Content displayでは、APIドキュメントに表示するフィールドをカスタマイズできるよ。例えば：

ベースURL

オーナー

エンドポイント説明の上に「最終更新」時間を表示

ドキュメントの最後に「最終更新」時間を表示

リクエストサンプル

OperationId

高度な設定

ユーザーにアクセスさせたくない情報を隠すことができるよ。例えば：

「Powered by Apidog」を隠す（プロフェッショナルプラン以上で利用可能）

「Run in Apidog」ボタンを隠す（プロフェッショナルプラン以上で利用可能）

「Try it out」ボタンを表示

「Export」や「Clone」データを許可

レイアウトとナビゲーション

ページレイアウトを簡単にカスタマイズできる。カスタムレイアウトについてもっと学ぶ。

高度な設定

ドキュメント検索

公開されたAPIドキュメントにはデフォルトで組み込みの検索機能があるけど、ApidogはAlgoliaとの統合で検索機能を強化できる。ドキュメント検索についてもっと学ぶ。

CORSプロキシ

ブラウザのセキュリティ制限による問題を避けるために、CORSプロキシを指定できる。CORSプロキシについてもっと学ぶ。

Google analytics

ApidogのドキュメントサイトはGoogle analyticsとの統合をサポートしている。Google AnalyticsとDoc Sitesの連携についてもっと学ぶ。

API Hubへの公開

API Hubにドキュメントを公開することもできる。これはApidogが運営するオープンプラットフォームで、APIの共有と探索に特化しているよ。

説明

プロジェクトがAPI Hubに公開されている場合、この説明がAPI Hubに表示されるよ。

「Export」や「Clone」データを許可

メインブランチでリリースされたドキュメントデータをエクスポートできる。

ドキュメントリダイレクトルール

URLが変更されたときにユーザーを正しいドキュメントに自動的にリダイレクトするルールを設定できる。これによりリンク切れを防ぎ、シームレスな体験を提供できるよ。

URL & Slugルール

APIドキュメントのURLルールを定義できる。

複数のドキュメントサイトを公開する

同じプロジェクト内で異なるチャネルにドキュメントを公開するために、公開中に追加のドキュメントサイトを作成できる。管理を簡単にするために、メインサイトの設定を各新しいサイトに複製できるよ。各サブサイトには独自のカスタムドメイン名を持たせることもできる。

サブサイトのみが公開されたドキュメントの可視性範囲を設定でき、どのリソースが公開されるかを選択できる。

ドキュメントサイトの公開

ドキュメントサイトを公開する#

ドキュメントサイトの可視性設定#

公開範囲#

リリース#

ドメイン#

カスタマイズ#

外観#

基本情報#

コンテンツ表示#

高度な設定#

レイアウトとナビゲーション#

高度な設定#

ドキュメント検索#

CORSプロキシ#

Google analytics#

API Hubへの公開#

説明#

「Export」や「Clone」データを許可#

ドキュメントリダイレクトルール#

URL & Slugルール#

複数のドキュメントサイトを公開する#

ドキュメントサイトを公開する

ドキュメントサイトの可視性設定

公開範囲

リリース

ドメイン

カスタマイズ

外観

基本情報

コンテンツ表示

高度な設定

レイアウトとナビゲーション

高度な設定

ドキュメント検索

CORSプロキシ

Google analytics

API Hubへの公開

説明

「Export」や「Clone」データを許可

ドキュメントリダイレクトルール

URL & Slugルール

複数のドキュメントサイトを公開する