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
      • 組織リソース
        • セルフホストランナー
  • 請求情報
    • 概要
    • プランのアップグレード
    • クレジット
    • クレジットカードが使えない?
    • サブスクリプションの管理
  • データ & セキュリティ
    • Apidogのデータはどこに保存され、データセキュリティはどのように確保されていますか?
    • ユーザーデータはどのように保存されますか?このデータは公開されますか?それともプライベートですか?すべてのデータはクラウドに保存されますか?
    • リクエストを送信する際、Apidogサーバーを経由しますか?データセキュリティは確保されていますか?
  • アドオン
    • 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. テストシナリオ実行

テストシナリオを実行する

テストシナリオを構築したら、それを実行してテストレポートを生成できます。

適切な実行方法の選択#

Apidogは、異なるテスト要件に応じた複数のテストシナリオ実行方法を提供しています。
1.
ローカルビジュアル実行:
この方法はローカルマシンから開始され、小規模で迅速なテストに適しています。開発とテストが同時に行われる場合に特に効果的で、リアルタイムでの監視と即時調整が可能です。
2.
ローカル Apidog CLI 実行:
大規模なデータや反復シナリオを処理するのに理想的で、実行速度が向上します。オフラインでの実行が可能で、リソースが制限された環境やグラフィカルユーザーインターフェースを必要としない環境に適しています。
3.
CI/CD 実行:
この実行スタイルはCI/CDパイプラインに統合されており、自動化された統合と継続的デプロイメントプロセスに最適です。特に、コードの更新後にAPIの安定性を確認するために頻繁にテストが実行される設定で役立ちます。
4.
セルフホスティングランナー実行:
チームは自分たちのサーバーにApidogランナーをセットアップし、より強力なコンピューティングリソースを活用してテストを行うことができます。この方法はスケジュールされたタスクのサポートを含んでおり、定期的なテストが必要なシナリオや大規模なテスト要求があるシナリオに理想的です。
TIP
テストシナリオでは、環境/グローバル変数が使用される場合、選択した実行方法によってこれらの変数の実際の値が異なる可能性があり、一貫性のないテスト結果を引き起こすことがあります。詳細はこちら。
まずはローカルビジュアル実行から始めましょう。

始め方#

1
希望するテストシナリオに移動し、リクエストを実行したい環境を選択します。
CleanShot 2024-07-24 at 19.43.17@2x.png
2
「実行」をクリックします。
3
現在の実行に関する合格率、実行時間、その他のデータを表示するテストレポートが表示されます。各リクエストを展開して、検証とアサーションを確認できます。
image.png
4
「詳細」をクリックして、実際のリクエストとレスポンスの詳細を確認します。
image.png
テストレポートについてもっと学ぶ。

テストシナリオでの実行オプション#

Apidogでテストシナリオを実行する際、特定の要件に合わせてテスト実行をカスタマイズするための設定とオプションをいくつか構成できます。
functional-test-settings.png
以下では、これらの設定の重要な側面を探ります:

環境#

シナリオ内のリクエストが向けられるサービス(基本URL)と使用する変数セットを指定します。環境とサービスで詳細を確認してください。
カスタムリクエストは独自の完全なURLを持ち、このコンテキストで設定された環境には向けられません。インポートされたステップとは異なります。

テストデータ#

テストシナリオは外部のテストデータセットのインポートをサポートしています。テストシナリオが実行されると、システムはデータファイル内のすべてのデータセットをループし、データセット内のデータを対応する変数に割り当てます。データ駆動型テストを参照してください。

イテレーション#

シナリオ内のすべてのステップがループで実行される回数を設定します。
処理するデータが多い場合は、ApidogクライアントではなくApidog CLIを使用して実行することをお勧めします。

スレッド#

データがスレッド間で分離されて干渉を防ぐために、すべてのステップを複数のスレッドで実行します。
この機能はベータ版であり、さらなるパフォーマンス最適化が必要な場合があります。厳密な負荷テストには、パフォーマンステスト機能を使用することをお勧めします。CLIではスレッドはサポートされていません。

実行先#

テストシナリオを実行するために実際にハードウェアリソースを消費するマシンです。テストシナリオで開始されたすべてのリクエストは、ここで指定されたマシンから送信されます。したがって、リクエストマシンのネットワーク環境の違いがテスト結果の変動を引き起こす可能性があります。
NOTE
この設定はテストシナリオの実行構成の一部として保存されません。毎回、デフォルトでローカルマシンがテストシナリオを実行するために使用されます。また、この設定はバッチ実行やCLI実行中には有効になりません。これらの場合、リクエストは現在のマシンのリソースを使用して開始されます。
テストシナリオを実行するマシンを指定する際、テストシナリオにファイル(ファイル送信、データベース接続、外部プログラム、SSL証明書など)が含まれる場合、必要なすべてのファイルが指定されたマシンにローカルに保存されている必要があります。

通知#

この機能を有効にすると、手動のテストシナリオが完了した後に指定された受信者に通知が送信されます。通知にはテスト結果の概要と詳細レポートへのリンクが含まれます。テストが終了するとすぐに通知を送信するか、失敗が発生した場合にのみ通知を送信するかを設定できます。これにより、不要なアラートを最小限に抑えることができます。通知設定で詳細情報を確認してください。

共有#

Advanced Settingsの右側にある「共有」オプションを有効にすると、各テストシナリオ実行後に生成されたテストレポートがプロジェクトの他のメンバーと自動的に共有されます。Test ReportsセクションのSharedタブでチーム内で共有されたすべてのテストレポートを表示できます。テストレポートで詳細を確認してください。
現在のテストシナリオに他のプロジェクトからインポートされたエンドポイントを含むステップがある場合、このガイドを参照してください:他のプロジェクトのAPIの実行環境を管理する

高度な設定#

エラー時の動作#

テストがエラーをどのように処理するかを設定します。これには、アサーションの失敗、データ形式の検証の失敗、サーバーエラーなどが含まれます。オプションは次のとおりです:
無視: エラーが発生した場合、次のステップを続行します(デフォルト設定)。
続行: エラーが発生した場合、現在のイテレーションを終了し、次のイテレーションを開始します。
実行終了: エラーが発生した場合、全体の実行を停止します。

遅延#

各ステップの送信間に一時停止を設定して、実行速度を管理および制御します。

リクエスト/レスポンスの保存#

デフォルトでは、Apidogはすべてのリクエストとレスポンスを保存します。リクエストやレスポンスが非常に大きい場合(数MBになる可能性があります)、かなりのディスクスペースを占有する可能性があります。このオプションを有効にして、すべてのリクエストとレスポンスを保存せず、アサーションと検証結果のみを保存することができます。
または、スペースを節約するために失敗したリクエストとレスポンスのみを保存することもできます。

変数値の保持#

このオプションはデフォルトで有効になっており、テスト中に変更された場合、グローバルおよび環境変数の現在の値が最後に変更された結果を保持します。このオプションを無効にすると、グローバルおよび環境変数はテスト実行後に変更されず、実行前の値を保持します。
ローカル変数はこの設定の影響を受けず、各実行後にクリアされます。

保存されたクッキーで実行#

Apidogの右下隅にあるクッキーアイコンは、クッキー管理にアクセスします。ApidogはAPIリクエストを行う際に自動的にクッキーを保存します。テストシナリオ実行中に保存されたクッキーを使用したい場合は、このオプションを有効にします。

実行後にクッキーを保存#

上記と同様に、テストシナリオを実行した後に保存されたクッキーを更新したい場合は、このオプションを有効にします。
Apidogでこれらの高度な設定を構成することで、特定のテストニーズに合わせてテスト実行を微調整し、効率的で正確なテスト実行を確保できます。

テストシナリオ設計モードでのランタイム設定#

テストシナリオ設計モードにいる場合、関連するランタイム構成は「実行」ボタンの右側に折りたたまれています。この設定ボタンにマウスをホバーすると、このテストシナリオの詳細なランタイム構成が表示されます。
image.png

機能テストの実行#

機能テストを実行した後、テストシナリオ実行ページに移動します。以下の画像の円グラフは、テストシナリオの実行中にリアルタイムで更新されるテスト結果の概要を提供します。円グラフの下には、実行中の各ステップのステータスが表示される詳細なテストステップが表示されます。
run-functional-test.jpg
機能テストの実行が完了すると、関連するエンドポイントをクリックして、テスト中のメトリクスとステータスを表示できます。これには、エンドポイント名、リクエストメソッド、リクエストURL、レスポンスステータスコード、レスポンスタイム、レスポンスコンテンツ、データ検証、およびアサーション結果が含まれます。詳細については、テストレポートを参照してください。

異なる実行方法での環境/グローバル変数の使用ルール#

環境およびグローバル変数は永続的であり、複数の実行や異なるテストシナリオにわたって長期間使用するために保存できます。ただし、選択した実行方法によって使用される実際の変数値が異なる場合があります。例えば:
テストシナリオが環境変数Tokenを使用する場合、クライアント内で実行すると正常に動作するかもしれませんが、セルフホストランナーを使用して実行するとTokenの値が正しくないために失敗する可能性があります。
この不一致は、実行中に環境変数Tokenの実際の値がクライアント内にローカルに保存された値から取得されるために発生する可能性があります。ただし、セルフホストランナーで実行する場合、ランナーには同じローカルに保存されたTokenがないため、失敗します。
この問題に対処するために、Apidogは異なる実行方法にわたって環境/グローバル変数の値を管理するための一連のルールを提供しています:
実行方法環境/グローバル変数の使用変数の保存場所
ローカル(クライアント、Web)環境/グローバル変数の現在の値を使用して実行します。ローカルに保存されます。手動で変更または前/後処理を通じて更新できます。環境管理 > 環境/グローバル変数 > 現在の値で表示されます。
CLI、CI/CDリアルタイムオンライン実行の場合:
  1. 環境/グローバル変数の初期値を使用して実行します (デフォルト)。
  2. テストシナリオを実行するマシン上のファイルに保存された環境/グローバル変数の値を使用するように--variables pathオプションを指定します。詳細はこちら。
エクスポートされたデータでの実行の場合:
  1. エクスポートされたファイルに含まれる環境/グローバル変数の値を使用して実行します。
  1. 初期値はApidog Cloudに保存され、クライアント内で手動でのみ変更できます。
  2. --variables pathオプションで指定されたファイルに保存され、手動で変更または前/後処理を通じて更新できます。
  3. エクスポートされたファイルに保存されます。手動で変更または前/後処理を通じて更新できます。
セルフホストランナー
  1. 環境/グローバル変数の初期値を使用して実行します (デフォルト)。
  2. ランナー内にローカルに保存された値を使用して実行します。詳細はこちら。
  1. 初期値はApidog Cloudに保存され、クライアント内で手動でのみ変更できます。
  2. 指定されたランナー内に保存されます。手動で変更または前/後処理を通じて更新できます。製品のユーザーインターフェースまたはランナー内の/opt/runner/variablesファイルで表示されます。

他のプロジェクトからのエンドポイントを含むテストシナリオの実行#

テストシナリオに他のプロジェクトからインポートされたエンドポイントが含まれる場合、実行中のこれらのエンドポイントのリクエストURLは環境関連付けで設定した構成によって決定されます。
例えば:
現在のプロジェクトの「開発環境」が他のプロジェクトの「本番環境」と関連付けられている場合、「開発環境」を使用してテストシナリオを実行すると、インポートされたエンドポイントは「本番環境」からのURLに送信されます。他のすべてのエンドポイントは、現在のプロジェクトの「開発環境」からのURLを使用します。
environment-association.jpg

様々なテストの実施#

ここで説明したステップは、テストシナリオの基本的な実行を表しています。テストシナリオを設定する際、さまざまな高度な設定を組み込んで、多様なテスト要件を満たすことができます。
データ駆動テスト: 多様なデータセットを使用してテストを実施し、さまざまなシナリオでのシステムの動作を検証します。
パフォーマンステスト: さまざまな負荷条件下でシステムのパフォーマンスを評価し、スケーラビリティと応答性を評価します。
スケジュールされたタスク: テスト活動の範囲、アプローチ、タイミングを詳細に計画します。
CI/CD統合: ビルド、テスト、デプロイメントプロセスを自動化し、信頼性の高い頻繁なソフトウェアリリースを確保します。
Modified at 2025-02-06 10:46:06
Previous
他のプロジェクトのAPIの実行環境を管理する
Next
統合テスト
Built with