Apidog Docs
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
Discord Community
Slack Community
X / Twitter
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. テストスイート
  • Apidog学習センター
  • はじめに
    • Apidog紹介
    • Apidogのナビゲーション
    • Apidogの基本概念
    • Apidog基本操作
      • 概要
      • 新しい APIを作成
      • APIにリクエストを送信
      • アサーションを追加
      • テストシナリオを作成
      • APIドキュメントを共有
      • さらなる探究
      • リクエストの送信とAPI保存
    • Apidogへの移行
      • 概要
      • 手動インポート
      • 定期インポート(データソース連携)
      • インポートオプション
      • データのエクスポート
      • Import from...
        • Postman からインポート
        • OpenAPI(Swagger)仕様のインポート
        • cURLのインポート
        • Markdownのインポート
        • Insomniaからのインポート
        • apiDocからのインポート
        • .harファイルのインポート
        • WSDLのインポート
  • API設計
    • 概要
    • 新しいAPIプロジェクトを作成する
    • エンドポイントの基本
    • API設計規範
    • モジュール
    • 複数のリクエストボディ例の設定
    • コンポーネント
    • 常用フィールド
    • グローバルパラメータ
    • API変更履歴
    • コメント機能
    • 一括API管理
    • カスタムプロトコルAPI
    • データモデル
      • 概要
      • 新規データモデルの作成
      • JSONなどからのデータモデル生成
      • データモデルを構築する
      • oneOf / allOf / anyOfの使い方
      • 識別器(Discriminator)の利用方法
    • Security schemes
      • 概要
      • Security Schemeの作成
      • Security Schemeの使用
      • オンラインドキュメントにおけるSecurity Scheme
    • 高度な機能
      • APIのカスタムフィールド
      • 関連テストシナリオ
      • パラメータリストの表示形式
      • APIのステータス
      • API固有識別子
  • API開発 & デバッグ
    • 概要
    • リクエストの生成
    • リクエストの送信
    • コード生成機能
    • デバッグケース
    • 動的な値
    • レスポンス検証
    • 設計優先 & リクエスト優先
    • テストケース
    • 環境 & 変数
      • 概要
      • 環境管理
      • 変数の使い方
    • Vault secrets
      • 概要
      • AWS Secrets Manager
      • Azure Key Vault
      • HashiCorp Vault
    • 前/後処理
      • 概要
      • 待機時間(Wait)
      • 変数の抽出
      • アサーション
      • データベース操作
        • 概要
        • MySQL
        • MongoDB
        • Redis
        • Oracle クライアント
      • スクリプト利用
        • 概要
        • 前処理スクリプト
        • 後処理スクリプト
        • Postmanスクリプトリファレンス
        • 共通スクリプト
        • 他のプログラミング言語の呼び出し
        • JavaScriptライブラリの利用
        • レスポンスの可視化
        • スクリプトの例
          • アサーションスクリプト
          • スクリプトでの変数の使用
          • スクリプトを使用したリクエストメッセージの変更
          • その他の例
    • 動的値モジュール
  • APIモックデータ
    • 概要
    • スマートモック
    • カスタムモック
    • モックの優先順位
    • モックスクリプト
    • クラウドモック
    • セルフホストランナーモック
    • モック言語 (ロケール)
  • APIテスト
    • 概要
    • テストシナリオ
      • テストシナリオの作成
      • 他のプロジェクトから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
    • Webhook
    • リクエスト作成
      • リクエストの基本
      • パラメータとボディ
      • リクエストヘッダー
      • リクエスト設定
      • 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を編集
    • エンドポイント適合性チェック
    • APIドキュメント完全性チェック
    • AI命名
    • よくある質問
  • 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スタートアップガイド
    • チーム管理
      • チーム管理
      • チームメンバーの管理
      • メンバーの役割と権限設定
      • チーム活動
      • チームリソース
        • 汎用ランナー
        • チーム変数
        • リクエストプロキシエージェント
      • リアルタイムコラボレーション
        • チームコラボレーション
    • プロジェクト管理
      • プロジェクト管理
      • プロジェクトメンバーの管理
      • 通知設定
      • プロジェクトリソース
        • Git接続
        • データベース接続
    • 組織管理
      • 組織管理
      • シングルサインオン(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 Schema
    • CSVファイルフォーマット
    • Java環境のインストール
    • ランナーのデプロイ環境
    • ApidogフレーバーMarkdown
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
Discord Community
Slack Community
X / Twitter
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. テストスイート

テストスイートのオーケストレーション

テストスイート作成後は、テスト内容を追加する。Apidog では、テスト管理の要件に応じて柔軟に使い分けられる「静的」「動的」の2モードを用意している。

テスト内容の取り込み#

「オーケストレーション」タブ内のテストスイート詳細ページで、「+ エンドポイントテストケースを追加」または「+ テストシナリオを追加」をクリックする。表示される選択ウィンドウで「静的」または「動的」モードを切り替えられる。
image.png

1. 静的モード#

実行対象のテスト項目を厳密に指定する用途に用いる。
🎯 コアロジック
選択したテストケースのIDをシステムが記録する。元のカテゴリに新規ケースが追加されても、このスイートの実行範囲は変わらないため、結果のコントロール性が担保される。
🚀 適用シナリオ
バグ修正確認(ホットフィックス):バグに強く関連する3〜5件のテストケースを選び「検証パッケージ」を構成。関係のないケースを走らせずに修正結果を素早く確認する。
コア業務の安定化(コアパス):注文→決済のような極めて重要で安定したプロセスでは、新人が不完全なテストケースをうっかり追加して監視アラートを鳴らす事態を避けたい。
旧バージョン互換性テスト:旧クライアントの互換確認に特化した旧APIテストケース群を選定して実施する。
⚠️ 保守特性
保守コスト高:この専用スイートに新たなケースを含める場合、手動で追加する必要がある。

2. 動的モード#

ルールによって実行対象のテスト項目を自動抽出する用途に用いる。
🎯 コアロジック
システムに「フィルタルール(Scope & Filter)」を保存する。実行のたびにプロジェクト全体をリアルタイムに走査し、条件に合致する最新のケースをすべて実行計画に取り込む。
🚀 適用シナリオ
モジュール単位の回帰テスト:「Trading Center」フォルダーをソースフォルダーに設定。テスターは当該フォルダーに新規ケースを作成するだけで、実行時に自動で取り込まれる。
スモークテスト:「優先順位=P0」というルールで動的スイートを作成。各リリース前に実行し、P0にマーキングされた重要ケースを自動で網羅する。
バージョン更改の検証:タグ機能を使い、ルールを「タグ=v2.5.0」に設定。開発完了後、このスイートを実行して当該バージョンの新機能を一括で確認する。
⚠️ 保守特性
保守コストゼロ:一度ルールを設定すれば、以後はスイート自体のメンテナンスは不要。ケースの属性(配置、タグ、優先度)のみを管理すればよい。

実行順序の調整#

取り込んだ内容は一覧表示され、ドラッグで実行順序を並べ替えられる。
「静的」に追加した項目は、「編集」から個別のテストケースを削除するか、グループごと削除できる。
image.png
「動的」に追加したグループは、グループ全体の削除またはフィルター条件の編集のみ可能で、グループ内の個別項目は削除できない。
image.png

詳細設定#

テストスイートの設計ページ右側にある「詳細設定」を展開すると、実行方法をより細かく制御できる。
image.png
image.png

実行環境#

定義:既定では、テストスイートで設定済みの実行環境を継承する。ここで環境を指定した場合は、その設定が実行時に優先される。
用途:同一のStep群を異なる環境で再利用したい場合に有効。

テストデータ#

実行時にテストデータを使用するかどうかを指定する。
テストデータなし:Stepは1回のみ実行し、データ駆動テスト(こちら)は行わない。
テストデータを使用:テストデータに基づき複数回実行する。パラメータ化テストに用いられる。

エラーの処理#

エラーの扱いを設定する。アサーション失敗、データ形式の検証失敗、APIリクエストの例外、サーバーエラーなどが含まれる。
無視:エラーが発生しても中断せず、後続のStepを続行する。
継続:エラー発生時、そのラウンドの残りStepをスキップし、次の実行ラウンドへ進む。
実行終了:エラーが発生した時点で後続のStepを直ちに終了する。

反復回数#

定義:各スレッドが全Stepを繰り返す回数。
用途:安定性検証や簡易的な負荷テストに用いる。

遅延時間#

定義:各テストStep完了後、次のStepを実行するまでに待機するミリ秒(ms)を設定する。
用途:高頻度のリクエストにより対象サーバーのレート制限やサーキットブレーカーを誘発しないようにし、テストの円滑な実行を確保する。

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

定義:テストレポートに、リクエストやレスポンスの詳細(Header、Body など)を含めるかを制御する。
オプション:
すべて:合否に関わらず全Stepの詳細を保存する。データ量が大きく、深いデバッグに向く。
失敗のみ:実行中に失敗したStepの詳細のみを保存する。推奨。ストレージ節約と失敗原因の迅速な特定に有効。
保存しない:詳細は保存せず、合否と所要時間のみを記録する。

環境変数/グローバル変数の値#

環境/グローバル変数の実値として、当該テストシナリオで使用する値を指定する。選択肢は2通り。詳細はこちらを参照。Runner に保存された変数値を使用する場合は、さらに使用する変数スコープを選択する必要がある。
このスコープ指定の目的は、実運用の必要に応じて変数を適切に分離し、あるスケジュール実行での変数変更が他のタスクの失敗を招く事態を避けることにある。スコープを選択すると、プロダクト画面に表示される入口から当該スコープ内の変数値を参照できる。
Runner 内の変数スコープ環境変数/グローバル変数の読み書き説明
現在のテストシナリオ内のみで共有
  • 指定した Runner において、当該テストシナリオ専用の永続化ファイルに環境/グローバル変数を保存する。
  • このファイルの変数を読み書きできるのは当該テストシナリオのみ。
影響範囲が最小のスコープ。前回実行の結果を次回実行で利用するようなケースに適する。テストシナリオ、タスク、タスクフォルダーの各変数ファイルは、Runner のコンテナパス「/opt/runner/variables」に保存される。
現在のスケジュールタスク内の全テストシナリオ間で共有
  • 指定した Runner において、当該スケジュールタスク専用の環境/グローバル変数ファイルを用意する。
  • 現在のスケジュールタスク内のすべてのテストシナリオが、このファイルの変数を読み書きできる。
影響が中程度の推奨スコープ。同一スケジュールタスク内の異なるテストシナリオ間でデータ共有が必要な場合に適する。
現在のスケジュールタスクフォルダー内の全スケジュールタスク間で共有
  • 指定した Runner において、当該タスクフォルダー専用の環境/グローバル変数ファイルを用意する。
  • 現在のフォルダー配下にあるすべてのスケジュールタスクとテストシナリオが、このファイルの変数を読み書きできる。
影響範囲が最大のスコープ。あるスケジュールタスクの実行が変数値を変更し、他のタスクが失敗する可能性がある。フォルダー内の複数タスク間で広くデータを共有する必要がある場合に適する。
Modified at 2026-01-15 05:56:39
Previous
テストスイートの作成
Next
ローカルでのテストスイート実行
Built with