Apidog Docs
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. APIドキュメント公開
  • Apidog学習センター
  • はじめに
    • Apidog紹介
    • Apidog基本操作
      • 概要
      • 新しい APIを作成
      • APIにリクエストを送信
      • アサーションを追加
      • テストシナリオを作成
      • APIドキュメントを共有
      • さらなる探究
      • リクエストを送信してAPIとして保存
    • Apidog基本知識
      • Apidog操作方法
      • Apidogの基本概念
    • 移行
      • 概要
      • 手動インポート
      • 定期インポート
      • インポートオプション
      • データのエクスポート
      • Import from...
        • Postman からインポート
        • OpenAPI(Swagger)仕様のインポート
        • cURLのインポート
        • Markdownのインポート
        • Insomniaからのインポート
        • apiDocからのインポート
        • .harファイルのインポート
        • WSDLのインポート
  • API設計
    • 概要
    • コンポーネント
    • 常用フィールド
    • グローバルパラメータ
    • API変更履歴
    • プロジェクトの作成
    • 一括API管理
    • APIの基本
    • 複数のリクエストボディ例の設定
    • Schemas
      • 概要
      • 新規Schemaの作成
      • スキーマを構築する
      • JSONなどからのSchema生成
    • Security schemes
      • 概要
      • Security Schemeの作成
      • Security Schemeの使用
      • オンラインドキュメントにおけるSecurity Scheme
    • 高度な機能
      • APIをテストステップとしてインポート
      • パラメータリストの表示形式
      • APIのカスタムフィールド
      • APIのステータス
      • API固有識別子
  • API開発とデバッグ
    • 概要
    • リクエストの生成
    • リクエストの送信
    • コード生成機能
    • APIケース
    • 動的な値
    • レスポンスの検証
    • 設計優先 & リクエスト優先
    • 環境 & 変数
      • 概要
      • 環境とサービス
      • 変数の使い方
    • Vault secrets
      • 概要
      • AWS Secrets Manager
      • Azure Key Vault
      • HashiCorp Vault
    • 前/後処理
      • 概要
      • Wait
      • 変数の抽出
      • アサーション
      • データベース操作
        • 概要
        • MongoDB
        • Redis
        • Oracle クライアント
      • スクリプト利用
        • 概要
        • 前処理スクリプト
        • 後処理スクリプト
        • Postmanスクリプトリファレンス
        • 共通スクリプト
        • 他のプログラミング言語の呼び出し
        • JSライブラリの使用
        • レスポンスの可視化
        • スクリプトの例
          • その他の例
          • スクリプトを使用したリクエストメッセージの変更
          • スクリプトでの変数の使用
          • アサーションスクリプト
    • 動的値モジュール
  • APIモック
    • 概要
    • スマートMock
    • カスタムMock
    • Mockの優先順位
    • Mockスクリプト
    • クラウドMock
    • セルフホストランナーMock
    • Mock言語 (ロケール)
  • 自動テスト
    • 概要
    • テストレポート
    • テストシナリオ
      • テストシナリオの作成
      • 他のプロジェクトからAPI/APIケースをインポートする
      • リクエスト間でデータを渡す
      • API/APIケースからのデータ同期
      • フロー制御条件
      • テストシナリオのエクスポート
    • テストシナリオ実行
      • データ駆動型テスト
      • スケジュールタスク
      • テストシナリオを一括実行する
      • 他のプロジェクトのAPIの実行環境を管理する
      • テストシナリオを実行する
    • APIテスト
      • 統合テスト
      • 回帰テスト
      • エンドツーエンド(E2E)テスト
      • パフォーマンステスト
    • Apidog CLI
      • 概要
      • Apidog CLIのインストールと実行
      • Apidog CLI オプション
    • CI/CD
      • 概要
      • Jenkinsとの連携
      • Gitlabとの統合
  • APIドキュメント公開
    • 概要
    • Google AnalyticsとDoc Sitesの連携
    • CORS プロキシ
    • クイック共有
    • 可視性設定
    • ドキュメントURLに値を埋め込む
    • APIドキュメントを表示する
    • フォルダツリー設定
    • API SEO設定
    • カスタムレイアウト
    • ドキュメント検索
    • カスタムドメイン
    • ドキュメントサイトの公開
    • APIバージョン
      • 概要
      • APIバージョンの作成
      • APIバージョンの公開
      • APIバージョンごとにAPIの共有
  • リクエスト送信
    • 概要
    • GraphQL
    • gRPC
    • WebSocket
    • SSEデバッグ
    • SOAP/Webサービス
    • デバッグ用のリクエストプロキシエージェントを使用する
    • Socket.IO
    • リクエスト作成
      • リクエストの基本
      • パラメータとボディ
      • リクエストヘッダー
      • リクエスト設定
      • HTTP/2
      • リクエスト履歴
    • 認証と認可
      • 概要
      • CAとクライアント証明書
      • Apidogがサポートする認可タイプ
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • レスポンスとクッキー
      • 概要
      • ApidogのAPIレスポンス
      • Cookieの作成と送信
      • リクエストのデバッグ
      • リクエストをAPIとして保存
  • ブランチ管理
    • 概要
    • 新しいスプリントブランチの作成
    • スプリントブランチの管理
    • ブランチ内でのAPIテスト
    • ブランチでAPIの設計
    • スプリントブランチのマージ
  • Apidog MCP Server
    • 概要
    • Apidogプロジェクト内のAPI仕様をApidog MCPサーバー経由でAIに接続する
    • Apidogが公開したオンラインAPIドキュメントをApidog MCPサーバー経由でAIに接続する
    • Apidog MCPサーバーを介してOpenAPIファイルをAIに接続する
  • ベストプラクティス
    • ガイド:ChatGPT APIのトークンとコスト計算
    • Apidog コラボレーションワークフロー
    • API署名の取り扱い方法
    • Apidogでの認証状態の管理
    • OAuth 2.0で保護されたAPIにアクセスする方法
  • 管理
    • オンボーディングチェックリスト
      • 基本概念
      • Apidogスタートアップガイド
    • チーム管理
      • チーム管理
      • チームメンバーの管理
      • メンバーの役割と権限設定
      • チーム活動
      • チームリソース
        • 一般ランナー
        • チーム変数
        • リクエストプロキシエージェント
        • データベース接続
      • リアルタイムコラボレーション
        • チームコラボレーション
    • プロジェクト管理
      • プロジェクト管理
      • プロジェクトメンバーの管理
      • 通知設定
    • 組織管理
      • シングルサインオン(SSO)
        • 概要
        • Microsoft Entra IDの設定
        • Okta設定
        • 組織のSSOを設定する
        • チームへのグループのマッピング
        • ユーザーアカウントの管理
      • SCIMプロビジョニング
        • SCIMプロビジョニング入門
        • Microsoft Entra ID
        • Okta
      • 組織リソース
        • セルフホストランナー
  • 請求情報
    • 概要
    • プランのアップグレード
    • クレジット
    • クレジットカードが使えない?
    • サブスクリプションの管理
  • アドオン
    • API Hub
    • Apidog IntelliJ IDEA プラグイン
    • リクエストプロキシ
      • Apidogウェブでのリクエストプロキシ
      • 共有ドキュメントでのリクエストプロキシ
      • Apidogクライアントでのリクエストプロキシ
    • ブラウザ拡張機能
      • Microsoft Edge
      • Chrome
  • アカウント & 設定
    • アカウント設定
    • 言語設定
    • データバックアップ
    • ネットワークプロキシ設定
    • ホットキー
    • Apidogの更新
    • OpenAPIアクセストークンの生成
    • アカウント削除
  • 参考資料
    • Swagger拡張機能
    • Socket通信:パケットの分断と結合
    • 用語の説明
    • よくある質問
    • API-デザインファーストアプローチ
    • Apidog OpenAPI/Swagger仕様拡張
    • JSONPath
    • XPath
    • 正規表現
    • JSONスキーマ
    • CSVファイルフォーマット
    • Java環境のインストール
    • ランナーのデプロイ環境
    • ApidogフレーバーMarkdown
  1. APIドキュメント公開

カスタムドメイン

デフォルトでは、ドキュメントは [サブドメイン].apidog.io ドメインでアクセス可能です。しかし、カスタムドメインを設定することで、組織に適したドメインでドキュメントにアクセスできるようになります。
カスタムドメインは、管理者権限を持つユーザーが設定できます。以下の手順に従ってカスタムドメインを設定してください。

カスタムドメイン設定の開始#

プロジェクトのShareモジュールで、カスタムドメインを設定するオプションにアクセスできます。サイドバーの 共有 メニューをクリックし、セカンダリメニューの Publish 設定ページに移動します。
カスタムドメイン というセクションが表示されます。編集 ボタンをクリックして、カスタムドメインの設定を開始します。
カスタムドメインの設定には2つのオプションがあります:
1.
CNAME方式: 推奨されるオプションです。設定と維持が最も簡単で、サブドメインやルートドメインにカスタムドメインを設定できる柔軟性があります。
2.
独自サーバー経由: このオプションはより高度で、Content Delivery Network (CDN) を使用するか、独自のサーバーにリバースプロキシを設定する必要があります。これらの技術に精通しているユーザー向けです。

CNAMEの設定#

この手順は、前のステップで CNAME方式 オプションを選択した場合にのみ適用されます。
DNSの設定はApidogの外部で、使用しているDNSプロバイダーで行います。
この手順には3つの部分があります:
1.
CNAMEレコードの設定
2.
変更が反映されるのを待つ

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 を選択するか、デフォルト値をそのまま使用することをお勧めします。
以下は、Cloudflareのコントロールパネルでの正しい設定の例です:
Cloudflareのコントロールパネルでの正しく設定されたカスタムドメイン
注意: CNAMEレコードは、同じ名前の他のレコードと共存できません。選択したサブドメインに対してAレコード、AAAAレコード、TXTレコード、またはその他の種類のレコードが既にある場合は、CNAMEレコードを追加する前にそれらを削除する必要があります。

Cloudflareを使用していますか?#

CloudflareのコントロールパネルでDNSを設定している場合、Cloudflareのプロキシ(オレンジ色のクラウド、ドメイン設定では「Proxy status」とも呼ばれる)が 無効 になっていることを確認してください。これには2つの理由があります:
このオプションは、ドメインのDNSターゲットを公開から隠し、Apidogがカスタムドメインの定期的なチェックを適切に実行するのを妨げます。
カスタムドメインは既にCDNの恩恵を受けています。
再度、ドキュメントが問題なく提供されるように、Cloudflareのプロキシを無効にしてください。

変更が反映されるのを待つ#

簡単に言うと、DNSの変更が反映されるまで 10分~48時間 待つ必要があるかもしれません。
先ほど説明したTTL(Time To Live)フィールドを覚えていますか?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 PolicyHTTP Only に設定
Alternate Domain Names (CNAMEs)カスタムドメイン名に設定(カスタムドメイン設定中にPublish設定で設定したものと同じ)
SSL CertificateAWS Certificate Manager (ACM) に保存されているカスタムドメインのSSL証明書に設定
3.
Origin Custom Headersに関する情報を提供します(Header NameとValueフィールドは、Origin Domain Nameを提供した後に表示されます)
Header NameValue
X-Apidog-Docs-Site-ID{docsSiteId} に設定
TIP
docsSiteId の値は、Apidogのプロジェクト設定で確認できます。
4.
Default Cache Behavior Settingsを構成します。以下は変更が必要な値です。
設定値
Viewer Protocol PolicyRedirect HTTP to HTTPS を選択
Allowed HTTP MethodsGET, HEAD, OPTIONS, PUT, POST, PATCH, DELETE を選択
Cache and origin request settingsUse legacy cache settings を選択。Headers、Query strings、Cookiesには All を選択
5.
AWS Web Application Firewall (WAF) を有効にしないでください。
6.
ページの下部にある Create distribution をクリックします。CloudFront Distributionsリストに新しく作成されたディストリビューションが表示されます。StatusがDeployedになるまで、In progressと表示されることに注意してください。
7.
カスタムドメインのDNSに新しいCNAMEレコードを追加し、ディストリビューションのCloudFront Domain Nameを指すようにします。これは、Distribution IDをクリックし、Generalタブの下にあるDistribution domain name(例:fd1fbc7cac6197.cloudfront.net)で確認できます。

独自のリバースプロキシサーバーの設定#

APIドキュメント用に独自のリバースプロキシサーバーを設定できます。以下の例では、Nginx をリバースプロキシサーバーとして使用します。
1.
簡単な設定のために、Nginx 設定ファイルに以下の内容を追加します。
Caddy設定例:
:8080 {
        handle_path /* {
                reverse_proxy http://{docsSiteId.apidog.io {
                        header_up X-Apidog-Docs-Site-ID {docsSiteId}
                        header_up Host "docs.example.com"
                }

      }
}
}
{docsSiteId} の値は、Apidogのプロジェクト設定で確認できます。
2.
カスタムドメイン名のDNSレコードをリバースプロキシサーバーを指すように設定します。

カスタムドメインのサブディレクトリにAPIドキュメントをデプロイ#

Apidogの 独自サーバー経由 を使用すると、APIドキュメントをカスタムドメインのサブディレクトリにデプロイできます。例えば、ドキュメントを https://example.com の /api-docs パスにデプロイできます。ユーザーが https://example.com/api-docs にアクセスすると、ApidogがホストするオンラインAPIドキュメントにアクセスします。

設定手順:#

1.
Apidogの カスタムドメイン 設定ページで、カスタムドメインを入力します。
2.
独自サーバー経由 を選択し、Use Subdirectory を有効にして、サブディレクトリパスを入力します。
3.
次に、ウェブサーバーの設定ファイルを変更する必要があります。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のウェブサイトは検索エンジンのランキングでHTTPのウェブサイトよりも高い権威を持つ可能性があります。

HTTPSを有効にする手順:#

1.
Publish ページに移動し、カスタムドメイン タブを開きます。
2.
HTTPS をオンにしてHTTPSを有効にし、必要に応じて Always Use HTTPS を有効にして、通信がハイジャックされたり中間者攻撃を受けたりするのを防ぎます。

SSL証明書の管理#

HTTPSを有効にした後、SSL証明書をどのように管理するかを選択できます:
Apidogが生成: Apidogが自動的にSSL証明書を生成します。
独自の証明書を使用: 証明書機関(例:Let's Encrypt)が発行したSSL証明書と秘密鍵をアップロードできます。

トラブルシューティング#

カスタムドメインの設定に問題がある場合は、Discord からお問い合わせください。

Apidog Europeを使用していますか?#

Apidog Europeを使用している場合、カスタムドメイン設定に正しいドメインを使用していることを確認してください。
以前の設定でのApidog Europeの正しいドメインは {docsSiteId}.eu.apidog.com です。
Previous
ドキュメント検索
Next
ドキュメントサイトの公開
Built with