プロフェッショナルな API ドキュメントには、プロフェッショナルなドメインがふさわしいです。デフォルトでは、Apidog ドキュメントは <subdomain>.apidog.io ドメインでアクセスできます。ただし、独自ドメインを設定することでこれをカスタマイズでき、組織のブランディングに合ったドメインで閲覧者がドキュメントにアクセスできるようになります。前提条件#
カスタムドメインを設定する前に、以下を確認してください。使用したいドメインの所有権または管理権限があること
（リバースプロキシ方式の場合）CDN またはリバースプロキシ設定に関する知識があること
カスタムドメイン設定の開始#
カスタムドメイン設定にアクセス するには、サイドバーの Publish Docs メニューに移動し、Publish 設定ページに進みます。Custom Domain セクションが表示されるので、Edit ボタンをクリックして設定を開始できます。カスタムドメインの設定方法#
カスタムドメインを設定する方法には、次の 2 種類があります。1.
CNAME（推奨）：設定と保守が最も簡単です。サブドメインとルートドメインの両方で機能し、最大限の柔軟性を提供します。
2.
リバースプロキシ（上級者向け）：コンテンツ配信ネットワーク（CDN）を使用するか、独自サーバーにリバースプロキシを設定する必要があります。これらの技術に詳しいユーザーに推奨されます。
CNAME の設定#
このセクションは、前の手順で CNAME オプションを選択した場合にのみ適用されます。
CNAME レコードを設定する#
フィールド名や設定手順は DNS コントロールパネルによって異なる場合がありますが、基本的な概念は同じです。不明な場合は、DNS プロバイダーに確認してください。type は、作成したい DNS レコードの種類です。ここでは CNAME を選択する必要があります。
name、または DNS entry は、サブドメインを入力する場所です。完全な形式（例：docs.example.com）で入力する必要がある場合もあれば、エイペックスドメインより前の部分（例：docs）だけを入力すればよい場合もあります。どちらを使用すべきかわからない場合は、DNS プロバイダーに確認してください。
target、value、または destination は、サブドメインの参照先を指定する場所です。DNS CNAME オプションを選択した際に、Apidog の Publish 設定でこの値を確認できます。{docsSiteId}.apidog.io のような形式になります。この値は完全な形式で入力してください（例：12345678.apidog.io）。
TTL というフィールドが表示される場合もあります。これは Time To Live の略です。DNS レコードをキャッシュできる秒数を表します。何を設定すればよいかわからない場合は、Auto を選択するか、デフォルト値のままにすることをお勧めします。
CNAME レコードは、同じ名前の別のレコードと共存できません。選択したサブドメインに対して、すでに A レコード、AAAA レコード、TXT レコード、またはその他の種類のレコードが存在する場合は、CNAME レコードを追加する_前に_、それらを先に削除する必要があります。
Cloudflare のコントロールパネルで DNS を設定している場合は、Cloudflare のプロキシ（オレンジ色の雲、ドメイン設定では「Proxy status」とも呼ばれます）が無効になっていることを確認してください。理由は 2 つあります。このオプションはドメインの DNS ターゲットを公開から隠すため、Apidog がカスタムドメインに対して定期チェックを適切に実行できなくなります。
カスタムドメインは、すでに CDN の恩恵を受けます。
変更が反映されるまでどのくらい時間がかかりますか？#
簡単に言うと、次の手順に進む前に、DNS の変更が反映されるまで 10 分から最大 48 時間待つ必要がある場合があります。先ほど説明した TTL（Time To Live）フィールドを覚えていますか？DNS レコードは一定期間キャッシュされます。通常、DNS レコードは頻繁には変更されないため、これはパフォーマンス上非常に有益です。DNS レコードが変更された場合、DNS キャッシュサーバーが変更を確認してそれに従って動作するには、キャッシュが期限切れになるまでの一定期間（TTL 値）が必要です。ほとんどの場合、次の最終手順に進む前に、少なくとも 10 分待つのが最適です。場合によってはもう少し早く更新されることもありますが、より長くかかることもあります。48 時間以上かかることはまれです。_伝播_と呼ばれるこのプロセスの進行状況を確認したいですか？WhatsMyDNS などの DNS ルックアップツールを使用できます。完全なサブドメインを入力し、ドロップダウンリストから CNAME を選択して、Search ボタンを押します。世界中の DNS キャッシュサーバーが応答し、それぞれのキャッシュ結果を知らせてくれます。大多数が割り当てられた CNAME 値で応答するまで、これらの結果を定期的に確認してください。CDN または独自のリバースプロキシサーバーの設定#
このセクションは、前の手順で リバースプロキシ オプションを選択した場合にのみ適用されます。
AWS CloudFront を設定する#
AWS CloudFront や Cloudflare Enterprise などのクラウドベンダーが提供する CDN サービスを利用して、独自のリバースプロキシサーバーとして設定できます。以下の例では、AWS CloudFront をリバースプロキシとして設定します。1.
AWS にログインし、CloudFront に移動します。Create Distribution をクリックします。 2.
ディストリビューション設定を構成します。変更が必要な値は以下の とおりです。
| 設定 | 値 |
|---|
| Origin Domain Name | {docsSiteId}.apidog.io に設定します |
| Name | オリジンの説明です。この値により、同じディストリビューション内の複数のオリジンを区別できるため、一意である必要があります。 |
| Origin Protocol Policy | HTTP Only に設定します |
| Alternate Domain Names (CNAMEs) | カスタムドメイン名に設定します（カスタムドメイン設定時に Publish 設定で設定したものと同じです） |
| SSL Certificate | AWS Certificate Manager（ACM）に保存されているカスタムドメイン用の SSL 証明書に設定します。 |
3.
Origin Custom Headers の情報を指定します（Header Name と Value フィールドは、Origin Domain Name を指定した後にのみ表示されます）
| ヘッダー名 | 値 |
|---|
| X-Apidog-Docs-Site-ID | {docsSiteId} に設定します |
{docsSiteId} は Docs Site ID であり、カスタムドメインパネルで確認できます。正しい ID を入力していることを確認してください。4.
Default Cache Behavior Settings を設定します。変更が必要な値は以下のとおりです。
| 設定 | 値 |
|---|
| Viewer Protocol Policy | Redirect HTTP to HTTPS を選択します |
| Allowed HTTP Methods | GET, HEAD, OPTIONS, PUT, POST, PATCH, DELETE を選択します。 |
| Cache and origin request settings | Use legacy cache settings を選択します。Headers、Query strings、Cookies には All を選択します |
5.
AWS Web Application Firewall (WAF) は有効にしないでください。
6.
ページ下部の Create distribution を クリックします。新しく作成されたディストリビューションが CloudFront Distributions リストに表示されます。ディストリビューションが Deployed になるまで、Status は In progress と表示されることに注意してください。
7.
カスタムドメインの DNS に新しい CNAME レコードを追加し、ディストリビューションの CloudFront Domain Name を指すようにします。これは、Distribution ID をクリックし、General タブの Distribution domain name で確認できます（例：fd1fbc7cac6197.cloudfront.net）。
Cloudflare をリバースプロキシとして設定する#
Cloudflare Workers を使用してリバースプロキシとして動作させることができます。これにより、Apidog が必要なプロジェクト識別子を受け取れるようにしながら、ドメインをプロキシ（Orange Cloud）状態のまま維持できます。2.
Create Application をクリックし、次に Create Worker をクリックします。（方法の選択を求められた場合は、Start with Hello World! で続行します）
3.
Worker に名前を付け（例：apidog-docs-proxy）、Deploy をクリックします。
4.
Edit Code をクリックし、既存のスクリプトを以下に置き換えます。
カスタムドメインパネルで {docsSiteId} を確認できます。targetHost 変数と docsSiteId 変数の両方に、正しい ID を入力していることを確認してください。
5.
Save and Deploy をクリックします。
6.
Worker の Settings タブに移動し、Domains & Routes を選択して、+Add ボタンをクリックします。
7.
カスタムドメイン（例：docs.example.com）を入力します。Cloudflare が DNS レコードと SSL 証明書を自動的に処理します。
8.
Cloudflare の SSL/TLS encryption mode が Full または Full (Strict) に設定されていることを確認し、Cloudflare と Apidog 間の安全な通信を可能にします。
Worker にカスタムドメインをアタッチする前に、ドメイン（例：example.com）がすでに Cloudflare アカウントに追加され、ネームサーバーが有効になっていることを確認してください。
独自のリバースプロキシサーバーを設定する#
API ドキュメント用に独自のリバースプロキシサーバーを設定できます。以下の例では、Nginx をリバースプロキシサーバーとして使用します。1.
簡単な設定として、Nginx 設定ファイルに以下の内容を追加します。
:8080 {
handle_path /* {
reverse_proxy http://{docsSiteId}.apidog.io {
header_up X-Apidog-Docs-Site-ID {docsSiteId}
header_up Host "docs.example.com"
}
}
}
{docsSiteId} は Docs Site ID であり、カスタムドメインパネルで確認できます。正しい ID を入力していることを確認してください。2.
カスタムドメイン名の DNS レコードを、リバースプロキシサーバーを指すように設定します。
カスタムドメインのサブディレクトリへの API ドキュメントのデプロイ#
設定手順：#
1.
Apidog の Custom Domain 設定ページで、カスタムドメインを入力します。
2.
Reverse Proxy を選択し、Use Subdirectory を有効にしてから、サブディレクトリパスを入力します。
3.
次に、Web サーバーの設定ファイルを変更する必要があります。Nginx を使用してサービスをプロキシしていると仮定すると、以下の設定を参照できます。
proxy_pass：クライアントリクエストを別のサーバー（Apidog の API ドキュメントサーバーなど）に転送します。
proxy_set_header：プロキシサーバーからアップストリームサーバーへ送信されるリクエストヘッダーを設定し、リクエストが適切に処理されるようにします。
/api-docs/ はカスタムドメインのサブディレクトリであり、Nginx 設定では / で終わる必要があります。
http://{docsSiteId}.apidog.io/ も / で終わる必要があります。
{docsSiteId} を Apidog のドキュメントサイト ID に置き換えてください。docs.example.com はサンプルのカスタムドメインです。実際のカスタムドメインに置き換えてください。
設定後、サーバー上で Nginx を再起動する必要があります。
HTTPS を有効にする#
Apidog のオンラインドキュメントは HTTPS プロトコルをサポートしており、HTTP と比べていくつかの利点があります。安全なデータ送信：HTTPS は SSL/TLS 暗号化を使用してデータ送信の安全性 を確保し、第三者による情報の傍受を防ぎます。
SEO 最適化：検索エンジンのクローラーは、より優れたセキュリティとプライバシー保護を提供するため、HTTPS の使用を好みます。そのため、HTTPS Web サイトは HTTP Web サイトよりも検索エンジンランキングで高い評価を得る可能性があります。
HTTPS を有効にする手順：#
1.
Publish ページに移動し、Custom Domain タブを開きます。
2.
HTTPS をオンにして HTTPS を有効にします。任意で、通信の乗っ取りや中間者攻撃を防ぐために Always Use HTTPS を有効にすることもできます。
SSL 証明書の管理#
HTTPS を有効にすると、SSL 証明書の管理方法を選択できます。Generated by Apidog：Apidog が SSL 証明書を 自動的に生成します。
Use Your Own Certificate：認証局（例：Let's Encrypt）によって発行された SSL 証明書と秘密鍵をアップロードできます。 トラブルシューティング#
カスタムドメインの設定で問題が発生している場合は、Discord からお問い合わせください。Apidog Europe を使用していますか？#
Apidog Europe を使用している場合は、カスタムドメイン設定に正しいドメインを使用していることを確認してください。以前の設定における Apidog Europe の正しいドメインは {docsSiteId}.eu.apidog.com です。 
