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/APIケースからのデータ同期

API/APIケースからインポートされたテストステップの場合、それらのリクエストデータは関連するAPI仕様/ケースと同期することができます。
Sync Data
API/APIケースをテストステップにインポートする際、手動モードまたは自動モードを選択できます。
手動モードは、複数人で協力するシナリオに適しています。つまり、プロジェクト内でAPI仕様、開発、テストプロセスが明確に分業されており、各プロセスに専任の担当者がいる場合です。これらのプロセスはデータの独立性を保つ必要があり、意図しない変更が互いに影響を与えないようにします。API仕様/ケースデータの安定性を確保した後、テスターは手動でテストステップと同期させることができます。
自動モードは、小規模なチームや独立した開発者に適しています。つまり、プロジェクト内でAPI仕様、開発、テストプロセスが単一の役割によって処理され、APIのメンテナンスとテストの効率が向上します。「API管理」内のAPI/APIケースが変更されると、テストステップ内のAPI/APIケースデータもそれに応じて調整され、「API管理」と「自動テスト」間のデータの一貫性が保たれます。
Sync Mode

同期関係#

テストステップのインポート方法関連データテストステップの同期モード同期内容
APIからインポート - 手動モードAPI仕様手動モード (テストステップで「更新」ボタンをクリック)✅ 「パラメータ名」、「Path」、「Method」、「前/後処理」などの変更

❌ 「パラメータ値」
APIからインポート - 自動モードAPI仕様自動モード (API仕様が更新され保存された時)✅ 「パラメータ名」、「Path」、「Method」、「前/後処理」などの変更

❌ 「パラメータ値」
APIケースからインポート - コピーAPI仕様手動モード (テストステップで「更新」ボタンをクリック)✅ 「パラメータ名」、「Path」、「Method」、「前/後処理」などの変更

❌ 「パラメータ値」
APIケースからインポート - 参照APIケース自動モード (APIケースが更新され保存された時)✅ 参照APIケースデータ、APIケースの変更はこのテストステップの内容に影響します。

手動同期モード#

手動モードが選択されている場合、関連ボタンは「青」で表示されます。「API管理」内のAPI仕様に変更がある場合、テストステップ内のデータはリアルタイムで更新されません。テスターは「テストステップ」の詳細で「更新」ボタンを手動でクリックして、API/APIケースからの変更をテストステップに同期させることができます。
このモードは、テスターがリクエストパラメータを微調整するための多数のリクエストを持つテストシナリオに適しており、これらのテストデータに意図しない影響を与えることを避け、テストデータと開発中のAPIデータの間の独立性を確保します。
Manual Sync
Sync Data
手動モードでは、関連ボタンのドロップダウンメニューもデータ同期の範囲を手動でフィルタリングすることをサポートしています。
Filter Sync

API仕様の同期#

API → 手動更新またはAPIケースからインポート → コピーによって生成されたテストステップの場合、関連する内容はAPI仕様です。これらのテストステップは、ページ上の「今すぐ同期」ボタンをクリックすることでAPI仕様の内容と同期させることができます。
手動同期をトリガーした後、テストステップはAPI仕様から「パラメータ名」、「前/後処理スクリプト」などのデータを同期します。同期対象はAPI仕様であり、API仕様内のリクエストパラメータにサンプル値が設定されていない場合、同期内容には「パラメータ値」が含まれません。
「API仕様」内のデータを保存および更新しても、関連するテストステップには影響しません。
Sync Endpoint spec
テストステップの「更新」ボタンをクリックすると、データ同期メカニズムがトリガーされ、ボタンは「同期済み」と表示されます。同期されたデータが正しいことを確認した後、右上の「保存」ボタンをクリックしてテストステップを保存する必要があります。
Save Sync

バッチ同期データ#

現在のテストステップのデータの大部分が手動モードを使用しており、テスターがこれらのAPI仕様/ケースのデータが正しいことを確認し、テストステップにデータを迅速に同期させたい場合、テストステップページの「更新」ボタンをクリックしてバッチ同期操作を実行できます。
Batch Sync

自動同期モード#

関連ボタンはオレンジ色で表示されます。前述の通り、このモードは単独の開発者がフローを制御し、追跡するのに役立ちます。
Automated Sync

API仕様の同期#

API仕様に関連付けられたテストステップの場合、同期モードが自動同期に設定されていると、API仕様に変更があり保存されると、テストステップ内のデータがリアルタイムで更新されます。同期内容は前述の手動同期モードと一致します。
Auto Sync Endpoints
自動モードでは、テストステップ内のデータとAPI仕様の間に不一致がある場合、それが強調表示されます。テスターは「元に戻す」を選択してAPI仕様と完全に一致させるか、「ドキュメントに保存」を選択してAPI仕様のデータをテストステップのデータで上書きし、一貫性を保つことができます。
Highlight Discrepancies

APIケースの同期#

テストステップで参照されているAPIケースのデータ管理の一貫性と一意性を確保するため、「API管理」システム内の参照APIケースを調整し、APIケースとテストステップが同じリクエストデータを利用するようにする必要があります。
テストステップページの指示で「編集」ボタンをクリックすると、関連するAPIケースページに移動して調整を行います。APIケースの変更後、テストステップは自動的に「パラメータ名」、「パラメータ値」、「前/後処理スクリプト」およびその他のすべてのリクエスト内容を同期します。
Sync Endpoint Cases
Previous
リクエスト間でデータを渡す
Next
フロー制御条件
Built with