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. テストシナリオ

リクエスト間でデータを渡す

自動テストシナリオにおいて、複数のリクエスト間でデータを受け渡すことは非常に一般的です。典型的なケースとしては以下のようなものがあります:
リクエスト1がログインリクエストでトークンを返し、リクエスト2がそのトークンを使用して他のデータをリクエストする。
リクエスト1がIDを返し、リクエスト2がそのIDに基づいて操作を行う。
リクエスト1がリストを返し、リクエスト2がそのリストのデータを使用する。
このようなシナリオに対応するため、Apidogではリクエスト間のデータ受け渡しを処理するための2つの異なるソリューションを提供しています。具体的な問題に応じて適切なソリューションを選択できます。
前ステップのデータを取得する: この機能を使用すると、後続のリクエストで前のリクエストのデータを直接使用できます。
利点はシンプルで、追加の変数を導入する必要がないことです。
ただし、データを複数回参照する必要がある場合には少し煩雑になる可能性があります。
前ステップのデータ取得機能は「自動テスト」モジュールでのみ使用可能で、「API管理」モジュールでは使用できません。
変数を使用する: 前のリクエストの前処理で「変数を抽出」を追加し、必要なデータを変数に保存し、後続のリクエストでこの変数を呼び出します。
利点は、データを複数回参照する場合に便利ですが、単一の参照の場合には少し複雑になる可能性があります。
変数は「自動テスト」モジュールと「API管理」モジュールの両方で使用できます。

前ステップのデータを取得する#

リクエスト1がログインリクエストでトークンを返し、リクエスト2がそのトークンを使用して追加のデータをリクエストするシナリオを考えてみましょう。
1
テストシナリオにログインリクエスト(リクエスト1)を追加します。
2
テストシナリオにクエリリクエスト(リクエスト2)を追加します。
3
リクエスト2のクエリパラメータには、リクエスト1が返したトークンを含める必要があります。リクエスト2のクエリパラメータのトークンフィールドにある「魔法の杖」アイコン 🪄 をクリックし、「前ステップのデータを取得」を選択します。
4
データ取得のためにリクエスト1を選択し、レスポンスボディを選択し、JSONPathを使用してリクエスト1が返したトークンを抽出します。例えば $.token のようにします。
5
「挿入」をクリックすると、クエリパラメータとして {{$.2.response.body.token}} が挿入されます。
6
テストシナリオの「実行」ボタンをクリックして、リクエスト1からリクエスト2へのデータ受け渡しを成功させます。
「前ステップのデータを取得」機能は「自動テスト」モジュールでのみ使用可能で、「API管理」モジュールでは使用できません。
「前ステップのデータを取得」を使用する場合、値はテストシナリオ全体を一緒に実行した場合にのみ取得可能で、個別のステップを実行した場合にはアクセスできません。

変数構文を使用して前ステップのデータを参照する#

前のテキストの {{$.2.response.body.token}} の例を使用します:
'2' はステップIDを表し、各テストステップで確認できます。
'response.body' は前ステップのデータの位置を示します。これにはリクエストのヘッダー、ボディ、またはレスポンスのヘッダーやボディなどのデータが含まれます。詳細は以下を参照してください。
'token' はボディ内の次のレベルの 'token' データを表します。JSONPath構文を使用して目的のデータを抽出できます。
前ステップのデータは、リクエストパラメータ、ヘッダー、認証など、リクエストのさまざまな部分で使用できます。また、以下のようにリクエストボディに直接データを挿入することもできます。
スクリプト内で前ステップのデータを使用する必要がある場合、{{variable}} 構文を使用して変数を直接参照することはできません。代わりに、pm.variables.get を使用して前ステップのデータを参照する必要があります。例えば:

構文リファレンス#

カテゴリ 機能 構文例
リクエストURL{{$.<ステップID>.request.url}}
パスパラメータ{{$.<ステップID>.request.pathParam.<フィールド名>}}
クエリ{{$.<ステップID>.request.query.<フィールド名>}}
ヘッダー{{$.<ステップID>.request.header.<フィールド名>}}
ボディ(フォーム){{$.<ステップID>.request.body.<フィールド名>}}
ボディ(JSON){{$.<ステップID>.request.body.<フィールドパス>}}
レスポンスボディ{{$.<ステップID>.response.body.<フィールドパス>}}
ヘッダー{{$.<ステップID>.response.header.<フィールド名>}}
Cookie{{$.<ステップID>.response.cookie.<フィールド名>}}
ループ要素(ForEachループ内の配列要素){{$.<ループステップID>.element.<フィールドパス>}}
インデックス{{$.<ループステップID>.index}}

変数を使用してデータを受け渡す#

リクエスト1がログインリクエストでトークンを返し、リクエスト2がそのトークンを使用して追加のデータをリクエストするシナリオを考えてみましょう。
1
テストシナリオにログインリクエスト(リクエスト1)を追加します。
2
リクエスト1の後処理で、「変数を抽出」アクションを追加し、$.token を {{token}} として抽出します。
変数を抽出について詳しく学ぶ。
3
テストシナリオにクエリリクエスト(リクエスト2)を追加します。
4
リクエスト2のクエリパラメータで変数 {{token}} を参照します。
5
テストシナリオの「実行」ボタンをクリックして、リクエスト1からリクエスト2へのデータ受け渡しを成功させます。

FAQ#

Q: なぜ前ステップのデータを正常に参照できないのですか?
A: まず、現在「自動テスト」モジュールにいることを確認してください。「前ステップのデータを参照」機能は「自動テスト」モジュールでのみ使用可能で、「API管理」モジュールでは使用できません。
「自動テスト」モジュールにいることを確認したら、「実際のリクエスト」タブに切り替えて、リクエスト内で参照されている前ステップのデータが正常に組み込まれているか確認してください。
実際のリクエスト内の参照が {{$.n.response.body.abc}} のまま表示され、実際のデータが表示されていない場合、参照が適用されていないことを示しています。
この場合、以下の一般的な理由を考慮してください:
1.
単一のステップではなく、テストシナリオ全体を実行しましたか?前ステップのデータを参照するには、テストシナリオ全体を実行する必要があります。
2.
ステップIDが正しく、参照したいステップに対応しているか確認してください。
3.
使用したJSONPathがデータソースと正確に一致していることを確認してください。
Previous
他のプロジェクトからAPI/APIケースをインポートする
Next
API/APIケースからのデータ同期
Built with