API/APIケースからインポートされたテストステップの場合、それらのリクエストデータは関連するAPI仕様/ケースと同期することができます。API/APIケースをテストステップにインポートする際、手動モードまたは自動モードを選択できます。手動モードは、複数人で協力するシナリオに適しています。つまり、プロジェクト内でAPI仕様、開発、テストプロセスが明確に分業されており、各プロセスに専任の担当者がいる場合です。これらのプロセスはデータの独立性を保つ必要があり、意図しない変更が互いに影響を与えないようにします。API仕様/ケースデータの安定性を確保した後、テスターは手動でテストステップと同期させることができます。自動モードは、小規模なチームや独立した開発者に適しています。つまり、プロジェクト内でAPI仕様、開発、テストプロセスが単一の役割によって処理され、APIのメンテナンスとテストの効率が向上します。「API管理」 内のAPI/APIケースが変更されると、テストステップ内のAPI/APIケースデータもそれに応じて調整され、「API管理」と「自動テスト」間のデータの一貫性が保たれます。同期関係#
| テストステップのインポート方法 | 関連データ | テストステップの同期モード | 同期内容 |
|---|
| APIからインポート - 手動モード | API仕様 | 手動モード (テストステップで「更新」ボタンをクリック) | ✅ 「パラメータ名」、「Path」、「Method」、「前/後処理」などの変更
❌ 「パラメータ値」 |
| APIからインポート - 自動モード | API仕様 | 自動モード (API仕様が更新され保存された時) | ✅ 「パラメータ名」、「Path」、「Method」、「前/後処理」などの変更
❌ 「パラメータ値」 |
| APIケースからインポート - コピー | API仕様 | 手動モード (テストステップで「更新」ボタンをクリック) | ✅ 「パラメータ名」、「Path」、「Method」、「前/後処理」などの変更
❌ 「パラメータ値」 |
| APIケースからインポート - 参照 | APIケース | 自動モード (APIケースが更新され保存された時) | ✅ 参照APIケースデータ、APIケースの変更はこのテストステップの内容に影響します。 |
手動同期モード#
手動モードが選択されている場合、関連ボタンは「青」で表示されます。「API管理」内のAPI仕様に変更がある場合、テストステップ内のデータはリアルタイムで更新されません。テスターは「テストステップ」の詳細で「更新」ボタンを手動でクリックして、API/APIケースからの変更をテストステップに同期させることができます。このモードは、テスターがリクエストパラメータを微調整するための多数のリクエストを持つテストシナリオに適しており、これらのテストデータに意図しない影響を与えることを避け、テストデータと開発中のAPIデータの間の独立性を確保します。手動モードでは、関連ボタンのドロップダウンメニューもデータ同期の範囲を手動でフィルタリングすることをサポートしています。API仕様の同期#
API → 手動更新またはAPIケースからインポート → コピーによって生成されたテストステップの場合、関連する内容はAPI仕様です。これらのテストステップは、ページ上の「今すぐ同期」ボタンをクリックすることでAPI仕様の内容と同期させることができます。手動同期をトリガーした後、テストステップはAPI仕様から「パラメータ名」、「前/後処理スクリプト」などのデータを同期します。同期対象はAPI仕様であり、API仕様内のリクエストパラメータにサンプル値が設定されていない場合、同期内容には「パラメータ値」が含まれません。
バッチ同期データ#
現在のテストステップのデータの大部分が手動モードを使用しており、テスターがこれらのAPI仕様/ケースのデータが正しいことを確認し、テストステップにデータを迅速に同期させたい場合、テストステップページの「更新」ボタンをクリックしてバッチ同期操作を実行できます。自動同期モード#
関連ボタンはオレンジ色で表示されます。前述の通り、このモードは単独の開発者がフローを制御し、追跡するのに役立ちます。API仕様の同期#
API仕様に関連付けられたテストステップの場合、同期モードが自動同期に設定されていると、API仕様に変更があり保存されると、テストステップ内のデータがリアルタイムで更新されます。同期内容は前述の手動同期モードと一致します。自動モードでは、テストステップ内のデータとAPI仕様の間に不一致がある場合、それが強調表示されます。テスターは「元に戻す」を選択してAPI仕様と 完全に一致させるか、「ドキュメントに保存」を選択してAPI仕様のデータをテストステップのデータで上書きし、一貫性を保つことができます。APIケースの同期#
テストステップで参照されているAPIケースのデータ管理の一貫性と一意性を確保するため、「API管理」システム内の参照APIケースを調整し、APIケースとテストステップが同じリクエストデータを利用するようにする必要があります。テストステップページの指示で「編集」ボタンをクリックすると、関連するAPIケースページに移動して調整を行います。APIケースの変更後、テストステップは自動的に「パラメータ名」、「パラメータ値」、「前/後処理スクリプト」およびその他のすべてのリクエスト内容を同期します。 
