Apidog Docs
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. 環境 & 変数
  • Apidog学習センター
  • はじめに
    • Apidog紹介
    • Apidogのナビゲーション
    • Apidogの基本概念
    • Apidog基本操作
      • 概要
      • 新しい APIを作成
      • APIにリクエストを送信
      • アサーションを追加
      • テストシナリオを作成
      • APIドキュメントを共有
      • さらなる探究
      • リクエストを送信してAPIとして保存
    • 移行
      • 概要
      • 手動インポート
      • 定期インポート
      • インポートオプション
      • データのエクスポート
      • Import from...
        • Postman からインポート
        • OpenAPI(Swagger)仕様のインポート
        • cURLのインポート
        • Markdownのインポート
        • Insomniaからのインポート
        • apiDocからのインポート
        • .harファイルのインポート
        • WSDLのインポート
  • API設計
    • 概要
    • コンポーネント
    • 常用フィールド
    • グローバルパラメータ
    • 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
      • 変数の抽出
      • アサーション
      • データベース操作
        • 概要
        • MySQL
        • MongoDB
        • Redis
        • Oracle クライアント
      • スクリプト利用
        • 概要
        • 前処理スクリプト
        • 後処理スクリプト
        • Postmanスクリプトリファレンス
        • 共通スクリプト
        • 他のプログラミング言語の呼び出し
        • JavaScriptライブラリの利用
        • レスポンスの可視化
        • スクリプトの例
          • その他の例
          • スクリプトを使用したリクエストメッセージの変更
          • スクリプトでの変数の使用
          • アサーションスクリプト
    • 動的値モジュール
  • APIモックデータ
    • 概要
    • スマートMock
    • カスタムMock
    • Mockの優先順位
    • Mockスクリプト
    • クラウドMock
    • セルフホストランナーMock
    • Mock言語 (ロケール)
  • 自動テスト
    • 概要
    • テストレポート
    • テストシナリオ
      • テストシナリオの作成
      • 他のプロジェクトからAPI/APIケースをインポートする
      • リクエスト間でデータを渡す
      • API/APIケースからのデータ同期
      • フロー制御条件
      • テストシナリオのエクスポート
    • テストシナリオ実行
      • データ駆動型テスト
      • スケジュールタスク
      • テストシナリオを一括実行する
      • 他のプロジェクトのAPIの実行環境を管理する
      • テストシナリオを実行する
    • APIテスト
      • 統合テスト
      • 回帰テスト
      • エンドツーエンド(E2E)テスト
      • パフォーマンステスト
    • Apidog CLI
      • 概要
      • Apidog CLIのインストールと実行
      • Apidog CLI オプション
    • CI/CD
      • 概要
      • GitHub Actions連携
      • Jenkins連携
      • GitLab連携
      • Gitコミットをトリガーとした自動テスト実行
  • APIドキュメント公開
    • 概要
    • サポート対象API技術
    • クイック共有
    • APIドキュメントを表示する
    • Markdownドキュメント
    • ドキュメントサイトの公開
    • カスタムレイアウト
    • カスタムCSS・JavaScript・HTML
    • カスタムドメイン
    • SEO設定
    • LLM最適化機能
    • 詳細設定
      • ドキュメント検索
      • CORS プロキシ
      • Google AnalyticsとDoc Sitesの連携
      • フォルダツリー設定
      • 可視性設定
      • ドキュメントURLに値を埋め込む
    • 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の設計
    • スプリントブランチのマージ
  • AI機能
    • 概要
    • AI機能の有効化
    • AIでSchemaを編集
    • よくある質問
  • Apidog MCP Server
    • 概要
    • Apidogプロジェクト内のAPI仕様をApidog MCPサーバー経由でAIに接続する
    • Apidogが公開したオンラインAPIドキュメントをApidog MCPサーバー経由でAIに接続する
    • Apidog MCPサーバーを介してOpenAPIファイルをAIに接続する
  • ベストプラクティス
    • API署名の取り扱い方法
    • OAuth 2.0で保護されたAPIにアクセスする方法
    • Apidog コラボレーションワークフロー
    • Apidogでの認証状態の管理
    • ガイド:ChatGPT APIのトークンとコスト計算
  • 管理
    • オンボーディングチェックリスト
      • 基本概念
      • Apidogスタートアップガイド
    • チーム管理
      • チーム管理
      • チームメンバーの管理
      • メンバーの役割と権限設定
      • チーム活動
      • チームリソース
        • 一般ランナー
        • チーム変数
        • リクエストプロキシエージェント
        • データベース接続
      • リアルタイムコラボレーション
        • チームコラボレーション
    • プロジェクト管理
      • プロジェクト管理
      • プロジェクトメンバーの管理
      • 通知設定
    • 組織管理
      • シングルサインオン(SSO)
        • 概要
        • Microsoft Entra IDの設定
        • Okta設定
        • 組織のSSOを設定する
        • チームへのグループのマッピング
        • ユーザーアカウントの管理
      • SCIMプロビジョニング
        • SCIMプロビジョニング入門
        • Microsoft Entra ID
        • Okta
      • 組織リソース
        • セルフホストランナー
  • 請求情報
    • 概要
    • プランのアップグレード
    • クレジット
    • クレジットカードが使えない?
    • サブスクリプションの管理
  • データ & セキュリティ
    • Apidogのデータはどこに保存され、データセキュリティはどのように確保されていますか?
    • ユーザーデータはどのように保存されますか?このデータは公開されますか?それともプライベートですか?すべてのデータはクラウドに保存されますか?
    • リクエストを送信する際、Apidogサーバーを経由しますか?データセキュリティは確保されていますか?
  • アドオン
    • API Hub
    • Apidog IntelliJ IDEA プラグイン
    • ブラウザ拡張機能
      • Microsoft Edge
      • Chrome
    • リクエストプロキシ
      • Apidogウェブでのリクエストプロキシ
      • 共有ドキュメントでのリクエストプロキシ
      • Apidogクライアントでのリクエストプロキシ
  • アカウント & 設定
    • アカウント設定
    • OpenAPIアクセストークンの生成
    • 言語設定
    • ホットキー
    • ネットワークプロキシ設定
    • データバックアップ
    • Apidogの更新
    • アカウント削除
    • 試験的な機能
  • 参考資料
    • Swagger拡張機能
    • Socket通信:パケットの分断と結合
    • 用語の説明
    • よくある質問
    • API設計優先アプローチ
    • Apidog OpenAPI/Swagger仕様拡張
    • JSONPath
    • XPath
    • 正規表現
    • JSONスキーマ
    • CSVファイルフォーマット
    • Java環境のインストール
    • ランナーのデプロイ環境
    • ApidogフレーバーMarkdown
  1. 環境 & 変数

環境管理

APIリクエストを行う際、開発・テスト・本番など複数の環境を切り替える必要があることが多い。Apidogでは、画面右上から簡単に環境を選択でき、異なる環境へのリクエスト送信がスムーズに行える。
Apidogの環境は、2つのコア要素で構成されている。1つ目は「Base URL」で、リクエストの送信先を管理する。2つ目は、リクエストやスクリプト内で参照できる1つ以上の「変数グループ」だ。環境を切り替えると、Base URLと環境変数の両方が、選択中の環境で定義された値に自動的に切り替わる。

環境の作成#

1
画面右上の「環境管理」ボタン(≡)をクリック。
2
左側リストの一番下にある「新しい環境を作成する」をクリック。
3
新しい環境名を入力し、Base URLや変数を追加する。
image.png
4
「保存」をクリック。
5
作成した環境を利用するには、画面右上の環境セレクターから選択する。これでその環境がアクティブとなり、全ての変数が環境で指定した値に設定される。
Apidogの環境は、Postmanの環境とは異なる。PostmanではBase URLごとに環境を分ける傾向があり、環境とBase URLの区別が曖昧になりがちだ。
一方、Apidogの環境は、開発・テスト・本番といった実際の運用環境をそのまま反映している。Base URLごとに環境を分けるのではなく、1つの環境内に複数のサービス(例:ユーザーサービス、注文サービスなど)をまとめて管理できる。ユーザー環境や注文環境のように、サービス単位で環境を分割する必要はない。

Base URLについて#

Base URLは、Apidog環境の中核となる機能だ。Apidogでは、APIのパスはスラッシュ(/)から始まり、Base URLは含まれない。APIリクエストを送信する際は、どのBase URLに送るかを明示的に指定する必要がある。そのため、環境ごとにBase URLを正しく設定することが重要となる。
Base URLの標準的な書式は、プロトコルから始まり、末尾にスラッシュ(/)を付けない形となる。
https://127.0.0.1
または
http://abc.com/v1
各Base URLは、特定のモジュールに紐付いている。通常、APIは所属するモジュールのBase URLを使ってリクエストを送信する。
例えば、本番環境のデフォルトモジュールのBase URLがhttp://abc.com/v1で、APIのパスが/petの場合、本番環境でリクエストを送信すると、実際のリクエスト先は
http://abc.com/v1/pet
となる。
APIパスがhttp://やhttps://で始まる場合、Base URLは付加されない。ただし、この運用は推奨されない。
BASE_URL変数
Apidogには、特別な環境変数「BASE_URL」が存在し、現在の環境の「Default Server」のBase URLを格納している。ただし、この変数の利用は推奨されない。
カスタムスクリプトでは、pm.request.getBaseUrl()を使って現在のAPIのBase URLを取得するのが推奨される。pm.environment.get('BASE_URL')は、APIが「Default Server」を使っていない場合、正しいBase URLを取得できない可能性がある。
ユーザーが手動で「BASE_URL」という環境変数を作成した場合、システムの「BASE_URL」よりも優先される。
なお、スクリプトからBase URL自体を変更することはできない。スクリプト内でpm.environment.set('BASE_URL', 'My_url')を実行すると、本当のbase URLが変わるのではなく、「BASE_URL」という名前の環境変数が新たに作成されるだけだ。

複数Base URLとモジュールの活用#

プロジェクト内で複数のBase URLを使い分ける場合は、Apidogのモジュールを活用するのが最適だ。
例えば:
ユーザー関連APIはhttps://user.example.comを利用
注文関連APIはhttps://order.example.comを利用
商品関連APIはhttps://product.example.comを利用
設定手順は以下の通り。
1
APIフォルダツリーの最上部で、必要な数だけモジュールを追加する。
image.png
2
環境管理画面で、各モジュールごとにBase URLを設定できる欄が表示されるので、実際のURLを入力し、「保存」をクリック。
image.png
3
モジュールのルートフォルダでは、そのモジュールのAPIがどのBase URLを使うかを選択できる。
デフォルト設定:そのモジュールで最初に登録したBase URLを利用(標準かつ推奨設定)。
手動指定:同じモジュール内の他のBase URLを手動で選択可能。1つのモジュールで複数サービスに接続する場合に使えるが、現在はこの方法は推奨されていない。サービスごとにモジュールを分ける方が望ましい。
image.png
4
モジュールのサブフォルダや個別のAPIページでも、使用するBase URLを指定できる。
親から継承:親フォルダの設定を引き継ぐ(デフォルト動作)。
手動指定:同じモジュール内の他のBase URLを選択可能。1つのモジュールで複数サービスに接続する場合に使えるが、現在はこの方法は推奨されていない。マイクロサービスの場合は、モジュールを分割して管理することを推奨。
image.png
5
正しい環境を選択したら、「送信」をクリックするだけでOK。個別のAPIリクエストでも自動テストでも、Apidogはモジュールと環境の設定に基づいて適切なBase URLを自動判定し、リクエストを送信する。
6
各環境には、プロジェクト内の全モジュールが含まれており、各モジュールごとにBase URLを個別に設定する必要がある。
image.png
これは、多くのチームで開発・テスト・本番ごとに異なるBase URLを利用しているためだ。右上の環境を切り替えるだけで、Apidogが自動的に環境ごとのBase URL設定に従って全APIリクエストを正しいサービスへルーティングするため、作業効率が大幅に向上する。
新規プロジェクト作成時には、デフォルトモジュールが1つ自動生成される。まれに、モジュールに有効なBase URLが見つからない場合は、このデフォルトモジュールのBase URLが利用される。

環境変数の追加#

環境に変数を追加する際、その変数の初期値(共有)と現在値(ローカル)を指定できます。
詳細については変数の使用を参照してください。

環境の切り替え#

Apidogはワークベンチの右上にある環境セレクタで現在の環境を表示します。リクエストの送信やスクリプトの実行時、Apidogは選択された環境のすべての変数の現在値を使用します。
異なる環境に切り替えるには、環境セレクタから選択するだけです。
Apidogでは、APIとリクエストは異なる概念です。APIはAPI仕様を表し、ベースURLは含まれません。一方、リクエストは具体的なAPIリクエストで、ベースURLを含みます。そのため、Apidog環境で定義されたサービスは、APIにのみ適用され、リクエストには適用されません。
リクエスト機能を使用する場合、Postmanと同様に{{Base_url}}構文を使用して環境変数を利用できます。

環境の移行#

Apidogでは、変数の初期値はチーム内で同期されますが、現在値はローカルにのみ保存されます。つまり、別のコンピュータでApidogを使用する場合、以前使用した現在値にアクセスできません。
そのため、Apidogは環境の移行機能を提供しています。環境内のサービスと変数をJSONファイルとしてエクスポートし、別のコンピュータにインポートできます。手順は以下の通りです:
1
環境管理で、環境リスト横の「...」にカーソルを合わせ、エクスポートをクリックしてJSONファイルを取得します。
2
別のコンピュータで環境管理を開き、環境リスト横の「...」にカーソルを合わせ、インポートをクリックします。JSONファイルを選択してインポートします。
3
Postmanからエクスポートした環境もインポートできます。

環境の可視性スコープ#

個人使用のみの変数を作成し、他のユーザーから見えないようにしたい場合があります。そのような場合は、「プライベート環境」を作成できます。
環境の右上で、環境の可視性スコープを設定できます。デフォルトでは共有されていますが、作成した環境を自分にのみ表示されるように設定できます。ただし、他のユーザーが作成した環境の可視性は変更できません。
プライベート環境は他の環境と同じサービスリストを共有します。プライベート環境でのサービスの追加や削除は、すべての環境に同時に影響します。
Modified at 2025-07-21 10:29:09
Previous
概要
Next
変数の使い方
Built with