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
      • 変数の抽出
      • アサーション
      • データベース操作
        • 概要
        • MySQL
        • 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ドキュメントを表示する
    • フォルダツリー設定
    • SEO設定
    • カスタムレイアウト
    • ドキュメント検索
    • カスタムドメイン
    • ドキュメントサイトの公開
    • LLM最適化機能
    • 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
  • アカウント & 設定
    • アカウント設定
    • OpenAPIアクセストークンの生成
    • 言語設定
    • ホットキー
    • ネットワークプロキシ設定
    • データバックアップ
    • Apidogの更新
    • アカウント削除
    • 試験的な機能
  • 参考資料
    • Swagger拡張機能
    • Socket通信:パケットの分断と結合
    • 用語の説明
    • よくある質問
    • API-デザインファーストアプローチ
    • Apidog OpenAPI/Swagger仕様拡張
    • JSONPath
    • XPath
    • 正規表現
    • JSONスキーマ
    • CSVファイルフォーマット
    • Java環境のインストール
    • ランナーのデプロイ環境
    • ApidogフレーバーMarkdown
  1. テストシナリオ

テストシナリオの作成

Apidogにおけるテストシナリオは、Postmanのコレクションに相当する基本的な単位です。複数のリクエストを連続して送信したり、連続したテストシナリオを構築したり、異なるテストデータでリクエストを繰り返したりする必要がある場合、テストシナリオを作成し、必要なリクエストを追加することができます。
Apidogでテストシナリオを使用することで、以下のようなAPIテストの要件を効率的に満たすことができます:
1.
順次リクエスト実行: 複数のリクエストを指定された順序で整理し、ユーザーインタラクションやプロセスフローをシミュレートします。
2.
テストレポート: アサーションや個々のリクエスト結果の詳細な可視化を提供するレポートを自動生成します。
3.
CI/CD統合: テストシナリオをCI/CDパイプラインに統合し、開発サイクル中に自動テストを実施することで、問題の早期発見を促進します。
4.
パフォーマンステスト: 様々な負荷下でのAPIパフォーマンスを評価し、時間経過に伴う応答動作の変化を特定するためのトレンド分析を生成します。
5.
動的パラメータテスト: 動的に生成されたパラメータを使用してリクエストを複数回実行し、APIが変動する入力に対応する方法をテストします。
6.
事前定義されたテストデータ: リクエストに事前設定されたデータを使用して、現実的な操作条件をシミュレートし、APIの応答を期待される出力と照合します。
7.
リクエスト間のデータ受け渡し: 1つのリクエストの出力データを自動的に別のリクエストに渡し、呼び出し間で状態を保持する必要があるAPIのテストに不可欠です。
8.
論理的なリクエスト関係: if、for、foreachなどの論理条件を設定し、前のリクエストの結果や特定の条件に基づいて実行フローを管理します。
これらの機能により、多様で効果的なテスト環境を作成し、堅牢で高品質なAPI開発に貢献することができます。

テストシナリオの作成#

Apidogを開き、「Tests」モジュールに移動し、検索バーの横にある+をクリックして新しいテストシナリオを作成します。適切なディレクトリを選択し、優先度を設定して作成を完了します。

テストステップの追加#

Apidogでテストシナリオを設定したら、リクエストを追加していくことができます。リクエストを追加する方法はいくつかあり、それぞれ異なるニーズと柔軟性に対応しています:
1.
API仕様にリンクされたリクエスト—これらのリクエストは、API仕様が変更されると更新される可能性があります:
a. API仕様からインポート: この方法では、API仕様内の構造化された定義から直接リクエストをインポートします。これにより、テストがAPIのドキュメント化されたインターフェースに準拠していることが保証されますが、特定のテスト条件を満たすためにリクエストパラメータを手動で調整する必要がある場合があります。
b. APIケースからインポート: このオプションを使用して、設定済みのパラメータを含む事前に定義されたAPIケースからリクエストを引き出します。これは、現実世界のAPI使用をシミュレートする標準化されたテストに特に有用で、テスト実行全体で一貫性を確保します。
2.
API仕様に関連付けられていない独立したリクエスト—これらのリクエストは、API仕様の変更に応じて更新されません。これにより、より多くのカスタマイズが可能になります:
a. カスタムリクエストを追加: 特定の要件に合わせてテストシナリオをカスタマイズするために、リクエストを一から作成します。このアプローチは、既存のAPI仕様の範囲を超えて探索するための最大の柔軟性を提供します。
b. cURLから追加: cURLを活用することで、カスタマイズされたリクエストを効率的にインポートまたは作成できます。これは、API仕様に制約されずに、複雑またはユニークなAPIインタラクションを模倣するリクエストを迅速に作成する便利な方法です。
3.
他のテストシナリオを参照:
a. 他のテストシナリオからリクエストを含める: この方法では、プロジェクト内で既に定義されている他のテストシナリオから特定のリクエストをインポートすることができます。
b. 他のテストシナリオを参照: 包括的なテストのために、別のテストシナリオ全体を使用する必要がある場合があります。この機能により、関連するすべてのテストと設定を統合し、セットアップ作業を重複させることなく、統一されたテスト戦略を促進することができます。

API仕様からインポート#

現在のプロジェクトからAPI仕様をテストシナリオのステップとしてインポートすることができます。APIをインポートする際には、「手動」と「自動」の2つのモードがあります。詳細な手順については、API/APIケースからのデータ同期を参照してください。
手動
「手動」モードでは、プロジェクト内のAPIドキュメントの変更がテストステップのAPIに即座に影響を与えることはありません。テストデータの同期は、テスターが「手動」ボタンをアクティブにしたときにのみ行われます。テストステップデータへの変更は、APIドキュメントを更新しないことに注意してください。このボタンをクリックすると、テストシナリオがAPIドキュメントから情報を取得して同期するためのものです。
自動
「自動」モードでは、プロジェクト内のAPIドキュメントの変更がテストステップに同期して更新されます。
1つのテストシナリオで他のプロジェクトのAPIをテストする必要がある場合は、他のプロジェクトからAPI/ケースをテストステップにインポートを参照してください。

APIケースからインポート#

現在のプロジェクトまたは他のプロジェクトからAPIケースをインポートすることができます。APIケースをインポートする際には、「コピー」と「参照」の2つのモードがあります。
コピー
APIケースを「コピー」としてインポートすると、APIケースのパラメータもテストステップにコピーされます。これらは互いに独立しており、それぞれの変更が他に影響を与えることはありません。手動同期を選択することができます。
参照
APIケースを「参照」としてインポートすると、元のプロジェクトのAPIケースを直接使用してリクエストを行います。
ケースから参照されたテストステップの場合、このステップを変更すると、元のAPIケースやそれを使用する他のステップにも影響があることを示すプロンプトが表示されます。
prompt-changes-effects.png

カスタムリクエストの追加#

作業プロセス中に、プロジェクト外のAPI(例えば、サードパーティの支払いAPI)を呼び出す必要がある場合があります。
テストステップにカスタムAPIリクエストを追加することができます。カスタムリクエストは、一般的なGET、POST、PUT、DELETEなどのHTTPリクエストを含む任意のリクエストです。

cURLから追加#

実際の作業プロセスでは、多くのAPIリクエストがcURLコマンドラインの形式で提示されます。テストステップにcURLリクエストをインポートするオプションがあり、ワンクリックで行うことができます。

他のテストシナリオからステップを含める#

同じプロジェクト内の他のテストシナリオからインポートすることで、テストステップやプロセス制御条件をクローンすることができます。

他のテストシナリオを参照#

他のテストシナリオをテストステップとして参照することができます。2つのユースケースがあります:
1.
ビジネスプロセスに共通の再利用可能なAPIテストステップがある場合、これらのステップを小さなテストシナリオにまとめ、他の広範なテストシナリオで直接参照することができます。
2.
製品全体の主流プロセスを回帰する必要がある場合、テストシナリオ内のさまざまなサブテストシナリオを参照して組み立て、ワンクリックで全ての主流プロセスのテスト回帰作業を完了することができます。
無限ループやテストシナリオが正常に停止できない状況を防ぐため、他のテストシナリオを参照する機能は、元のテストシナリオ自体を参照することはできません。

テストシナリオのオーケストレーション#

任意のテストステップをクリックすると、オーケストレーションモードに入ります。このモードでは、各テストステップの詳細な内容をより効率的に入力するための大きな操作ページが表示されます。ページの左側にはテストシナリオの全体フローが表示され、右側には選択されたテストステップの詳細が表示されます。APIリクエストとテストプロセス制御コンポーネントは、異なる表示パネルを持ちます。
ステップの順序は、ステップの前にある≡をドラッグして調整することができます。
このモードでは、「⬆️」と「⬇️」キーを使用して、選択されたテストステップ間を迅速に切り替えることができます。
オーケストレーションモードでは、複数のステップを編集し、左上隅の「すべて保存」ボタンをクリックして全ての変更を保存することができます。
未保存の変更があるステップは、左側のリストバーにドットでマークされます。変更を常に保存することを忘れないでください。
Modified at 2025-02-08 08:01:29
Previous
テストレポート
Next
他のプロジェクトからAPI/APIケースをインポートする
Built with