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

ドキュメントサイトの公開は、クイック共有機能の使用とは異なります。クイック共有は内部および外部のパートナーに共有可能なリンクを生成し、一時的なコミュニケーション手段として機能しますが、長期的な使用を目的としていません。

それに対して、ドキュメントサイト 機能はより堅牢なカスタマイズを可能にします。ドメイン名、ページデザイン、ナビゲーションなどを個別に設定できます。この機能は、公式ウェブサイトでAPIドキュメントを公開する必要がある場合に最適です。

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

デフォルトのメインサイトをクリックし、公開ボタンをクリックします。

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

Apidogのバージョンは≥ 2.7.15である必要があります。

公開ボタンをクリックした後、ニーズに応じて公開されたドキュメントサイトの可視性を簡単に制御できます。今すぐ公開 ボタンをクリックするだけで、サイトを公開できます。

公開

ドキュメントサイトはすべてのインターネットユーザーがアクセス可能になります。また、Apidogが運営するプラットフォームAPI HubでAPIドキュメントを公開することも選択できます。

パスワード保護

IP ホワイトリスト

メールホワイトリスト

カスタムログインページ

公開範囲

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

リリース

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

release settings for API Documentations.jpg

共有ドキュメント内で、ドキュメント利用者がBase URLを変更する方法

Apidogオンラインドキュメントで、ヘッダー（例：Token）を共有する方法

ドメイン

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

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

domain settings for API documentations.jpg

カスタマイズ

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

こちらでドキュメントをリアルタイムでプレビューできます。よろしければ、保存してください。

外観と表示内容

外観と表示内容設定では、APIドキュメントの基本項目を設定できます。例えば、次のような項目です。

タイトル

Logo

Favicon

テーマカラー

背景色

言語

ライト／ダークモード

「表示コンテンツ」では、APIドキュメントに表示する項目をカスタマイズできます。例えば、次のような項目です。

ベースURL

担当者

APIの説明の上に「最終更新」時刻を表示

ドキュメント末尾に「更新日時」時刻を表示

リクエストコードサンプル

タグ

Schema

OperationId

「Run in Apidog」ボタンを非表示（Professional 以上のプランで利用可）

「デバッグ」ボタンを表示

「エクスポート」「クローン」を許可

など

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

ページレイアウトを簡単にカスタマイズできます。詳しくは［カスタムレイアウト］をご覧ください。

カスタムランディングページ

公開ドキュメントのホームページを、Markdown または CSS と JavaScript を組み合わせた HTML でカスタマイズできます。

カスタムCSS・JavaScript・HTML

グローバルCSS、JavaScript、フッターHTMLを設定できます。詳細は下記ドキュメントをご覧ください。
カスタムCSS・JavaScript・HTMLのドキュメント

高度な設定

ドキュメント検索

公開された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に表示されるよ。

「エクスポート」や「クローン」データを許可

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

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

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

URL & Slugルール

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

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

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

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

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