Apidog Docs
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. 環境 & 変数
  • 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では、インターフェース右上で環境を選択するだけで、異なる環境へのリクエスト送信が簡単に行えます。
Apidogの環境は2つの主要要素で構成されています。1つ目は「サービス(ベースURL)」で、リクエストの送信先を管理するために使用されます。2つ目は、リクエストやスクリプトで参照できる1つまたは複数の「変数」のグループです。環境を切り替えると、サービス(ベースURL)と環境変数の両方が、現在の環境で定義された値を使用します。

環境の作成#

1
インターフェース右上の「環境管理」ボタン「≡」をクリックします。
2
左側リストの最後の項目「新しい環境を作成する」をクリックします。
3
新しい環境の名前を入力し、サービスのベースURLと変数を追加します。
image.png
4
「保存」をクリックします。
5
新しい環境を使用するには、インターフェース右上の環境セレクタから選択します。これにより環境がアクティブになり、すべての変数が環境で指定された値に設定されます。
ApidogとPostmanでは環境の考え方が異なります。Postmanでは各ベースURLを別々の環境として扱う傾向がありますが、これは環境とベースURLの区別を曖昧にしています。
一方、Apidogの環境は、開発、テスト、本番といった実際の環境を直接反映し、各ベースURLを単一の環境として扱うことはありません。
例えば、テスト環境内には、ユーザーサービスや注文サービスなど、様々なサービスが同じテスト環境内に含まれることがあります。これらのサービスを別々のユーザー環境や注文環境に分けるべきではありません。

サービス(ベースURL)#

サービス(ベースURL)は、Apidog環境の主要機能です。Apidogでは、APIはスラッシュ(/)で始まり、ベースURLは含まれません。APIリクエストを送信する際は、送信先のベースURLを指定する必要があります。これは環境内のサービス機能の重要性を示しており、APIリクエストの送信には特定の環境の選択が前提となります。
標準的なベースURLの形式は、プロトコルで始まり、末尾のスラッシュ(/)は含まない形式です:
https://127.0.0.1
または
http://abc.com/v1
各環境には「デフォルトサーバー」があります。APIが特定のサービスを指定していない場合、リクエストはデフォルトサーバーに転送されます。
例えば、本番環境の「デフォルトサーバー」のベースURLが「http://abc.com/v1」で、APIのパスが「/pet」の場合、本番環境でリクエストを送信すると、実際のリクエストは以下のようになります:
http://abc.com/v1/pet
APIのパスが http:// または https:// で始まる場合、ベースURLは追加されません。ただし、この方法は一般的に推奨されません。
BASE_URL変数について
Apidogには、現在の環境の「デフォルトサーバー」のベースURLを保存するBASE_URLという特別な環境変数があります。
この変数の使用は一般的に推奨されません。カスタムスクリプトでは、現在のAPIのベースURLを取得するために「pm.request.getBaseUrl()」を使用することをお勧めします。「pm.environment.get('BASE_URL')」の使用は避けてください。APIが「デフォルトサーバー」を使用していない場合、現在のAPIのベースURLを正しく取得できない可能性があります。
ユーザーが手動でBASE_URLという環境変数を作成した場合、システムの定義済みBASE_URLより優先されます。
スクリプトでベースURLを変更することはできません。スクリプト内の「pm.environment.set('BASE_URL', 'My_url')」は、ベースURL自体を変更するのではなく、BASE_URLという実際の環境変数を作成します。

複数サービスの利用#

プロジェクトで複数の異なるサービスを使用する場合(例:ユーザー関連のリクエストをhttps://user.abc.com へ、注文関連のリクエストをhttps://order.abc.com へ送信する場合)、複数のサービスを利用する必要があります。具体的な手順は以下の通りです:
1
1.環境に複数のサービスとそれぞれのベースURLを追加します。
image.png
2
APIを指定のサービスに割り当てます。
設計モードでは、「編集タブ」のServiceドロップダウンからサービスを選択します。
image.png
デバッグモードでは、「情報タブ」のServiceドロップダウンからサービスを選択します。
image.png
3
フォルダ単位でもサービスを追加できます。フォルダ名をクリックし、フォルダ設定でServiceドロップダウンからサービスを選択します。そのフォルダ内のすべてのAPIがこのサービスに転送されます。
4
インターフェース右上で環境を選択して送信すると、サービスに紐付けられたAPIは対応するベースURLに転送されます。
5
環境管理で異なる環境に切り替えると、ユーザーサービスと注文サービスが他の環境にも追加されているが、ベースURLが空になっていることに気付くかもしれません。
image.png
これは、ほとんどのチームでテスト環境と開発環境に対応するサービスがあるためです。各環境のそれぞれのベースURLを設定することで、右上で環境を切り替えると、すべてのAPIリクエストが正しいサービスに転送されます。実際には、これが最も効率的な設計アプローチです。

環境変数の追加#

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

環境の切り替え#

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

環境の移行#

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

環境の可視性スコープ#

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