メインコンテンツまでスキップ

カスタムドメインの操作ガイド

CNAME 方式​

Canonical Nameの略であるCNAMEは、あるドメイン名を別のドメイン名にマッピングするために使用されるエイリアスレコードです。ドメイン名を別のドメイン名にマッピングし、他のドメイン名によってIPアドレスを提供するようにする場合、CNAMEレコードを追加する必要があります。

現在、公開ドキュメントはhttps://www.apidog.com のURL形式を使用しています。www.abc.com などの特定のドメイン名を使用する必要がある場合は、カスタムドメイン機能を理解して使用する必要があります。次の方法でCNAMEを設定することができます。

ご案内：ご使用のドメイン名が関係当局に提出されていることを確認してください。

CNAMEの値を取得​

カスタムドメインページでは、対応するCNAME 値を見つけて、下の図に示すようにコピーをクリックします。下記の画像に示すように：

adada

CNAMEレコードを追加​

CNAMEレコードの追加は、ドメイン名のプロバイダーが設定する必要があります。たとえば、NameCheap、domain.comからドメイン名を購入した場合は、ドメイン名プロバイダーの関連する管理コンソールにアクセスして、CNAMEレコードを追加します。

  1. ドメイン名プロバイダの公式ウェブサイトを開き、ログインし、ページの右上隅にあるコンソールまたは関連する管理ページを見つけます。ドメイン名の解析をどこからアクセスするかを知っていない場合、ドメイン名プロバイダーの製品ドキュメントを参照するか、アフターサービスまでご連絡ください。

  2. ドメイン名のプロバイダのコンソールで、ドメイン名の解析追加用のページを見つけます。具体的な操作ガイドは、それぞれの製品ドキュメントを参照するか、アフターサービスまでご連絡ください。

  3. ドメイン名製品のリストで、加速ドメイン名に対応するメインドメイン名を見つけ、ドメイン名の背後にある解析設定または解析をクリックします。

  4. レコードの追加を選択し、ホストレコード、レコードタイプ、レコード値を順番に入力すると、その他をデフォルト値に設定できます。

パラメータ記入案内メモ
ホストレコード一般的に、サブドメインのプレフィックスを指します。（たとえば、https://www.apidog.com/としてサブドメインを作成するには、ホストレコードとして「www」と入力します。apidog-doc.comを実装するには、ホストレコードとして「@」と入力します。）唯一のパラメータ、カスタマイズ不可
レコード種類CNAMEを選択唯一のパラメータ、カスタマイズ不可
ライン種類デフォルト設定を維持必要に応じてパラメータを変更可能
レコード値ApidogからコピーされたCNAME唯一のパラメータ、カスタマイズ不可
TTLデフォルト設定を維持必要に応じてパラメータを変更可能

「カスタムドメインが有効ではありません」問題のトラブルシューティング

  • まず、CNAME 設定が有効になるのに通常約 10 分かかりますので、しばらくお待ちください。
  • それでも有効になっていない場合は、次の理由が原因を検討します：
    • CNAMEの設定に失敗しました。ドメイン名管理ページにアクセスして、CNAMEが正しく設定されているかどうかを確認してください。
    • ドメイン名は関係当局に認証を通されていません。

独自サーバー経由の方式​

バージョン2.2.19 以降、必要に応じて独自のサーバー経由機能を使用するには2つの方法があります。

  • 方法 1：nginxなどのWebサーバーを使用して、簡単な設定によって実現されます。つまり、Webサーバーのプロキシです。
  • 方法 2：NameCheap、domain.comなどのクラウドプロバイダーのフルサイトアクセラレーションサービス（DCDN）を使用する。つまり、前サイトアクセラレーションサービスは、指定されたアドレスにドメイン名をプロキシして、RequestのHeaderを正しく設定することで、ドメイン名に正常にアクセスし、プロジェクトドキュメントを表示するようにします。

方法 1：Web サーバー​

  • Nginxを使用してサービスをプロキシし、独自のサーバー経由機能を使用できます。
  • Nginxでは、proxy_passコマンドを使用して、他のサーバーにRequestを送信します。
  • Nginxでは、proxy_set_headerコマンドを使用して、プロキシサーバーを介してアップストリームサーバーに送信されるRequestのHeaderを設定します。
  • たとえば、次のコンテンツをNginxの配置ファイルに追加して、簡単な設定を行います。
server {
    ...
    location / {
        proxy_pass  http://{projectId}.apidog.io;
        proxy_set_header X-Apidog-Project-ID {projectId}；
        # Set your custom domain name to the Host value (Eg. app.apidog.com).
        proxy_set_header Host app.apidog.com;
        ...
    }
    ...
}

  • ご注意：

    上記の設定{projectId}はプロジェクトIDです。正しいIDを入力し、X-Apidog-Project-IDRequestのHeaderが正しく設定されていることを確認してください。

方法 2：CDN（コンテンツアクセラレーションサービス）​

  • NameCheap、domain.comなどのクラウドプロバイダーの全サイトアクセラレーションサービス（DCDN）を利用して、ソースサーバーを構成し、カスタムバックエンドHTTPヘッダーを定義することで、独自サーバー経由機能を使用できます。

    全サイトアクセラレーションサービスでは、アクセラレーションドメインを追加し、次の2つの操作を実行できます。

    • ソースサーバー情報を設定し、ソースサーバータイプをドメイン名に選択し、正しいドメイン名 {projectId}.n3.apidog.ioを設定する必要があります。
    • オリジン設定で、カスタムバックエンドHTTP RequestのHeaderを追加します：
      • パラメータ： X-Apidog-Project-ID
      • 値： {projectId}.

  • 前述の設定では、{projectId}はプロジェクトIDを参照していることに注意してください。正しいIDが入力されていることを確認してください。