デバッグケース

Apidog では、エンドポイントとデバッグケースを区別しています。各エンドポイントには、複数のデバッグケースを関連付けることができます。エンドポイントの URL またはパラメータを更新すると、関連するすべてのデバッグケースが自動的に更新されます。追加の作業は必要ありません。

一方、Postman では、すべてが個別の独立したリクエストとして扱われます。つまり、URL またはパラメータを変更した場合、影響を受けるすべてのリクエストを 1 つずつ手動で更新する必要があります。

デバッグケースの作成

エンドポイントの Run タブでリクエストを送信する、またはデバッグする際に、リクエストを永続的に保存したい場合は、Save as case をクリックできます。この操作により、リクエストはエンドポイントの構造内にデバッグケースとして保存されます。

デバッグケースに名前を付け、レスポンスも同時に保存するかどうかを選択できます。

前述のとおり、エンドポイント仕様はエンドポイント内に保存され、値はデバッグケースに保存されます。具体的には、デバッグケースには次のデータが含まれます。

リクエストパラメータ値: パスパラメータ、クエリパラメータ、ヘッダーパラメータ、および form-data 形式のボディパラメータを対象とします。

ボディ内容: RAW、JSON、XML などの形式です。

リクエスト前およびリクエスト後のプロセッサ。

受信したレスポンスの詳細。

レスポンス検証設定: 検証が有効かどうか、およびどのレスポンスに対して検証するかを示します。

そのため、エンドポイント仕様内のパラメータ仕様を変更すると、デバッグケースはリアルタイムで更新されます。

デバッグケースは、自動テストシナリオのテストステップとして参照できます。参照されると、デバッグケース内のリクエストパラメータがテストステップに直接適用されます。デバッグケースに加えられた変更が、それを参照するすべてのテストステップに自動的に反映されることを示す明確な通知を確認できます。

右上隅の参照アイコンをクリックすると、どのテストシナリオがそのデバッグケースを参照しているか、および使用しているテストシナリオの合計数を確認できます。これにより、自動テストでどのように使用されているかを把握できます。

テストシナリオをクリックすると、シナリオ詳細ページに移動し、そのケースを使用している関連ステップが見やすいようにハイライト表示されます。

デバッグケースを参照しているテストステップをクリックすると、変更が元のケースと同期されることが通知されます。

API 仕様を十分に定義します。

各エンドポイントに対して複数のデバッグケースを作成し、さまざまな条件をカバーします。

各デバッグケースについて、アサーションまたはその他のリクエスト前およびリクエスト後のプロセッサを作成します。

自動テストでデバッグケースを参照し、テストシナリオを構成します。

API 仕様に更新がある場合、デバッグケースとテストシナリオの両方を同期できます。テストシナリオを手動で更新するか、自動的に更新されるように設定するかを選択できます。