デバッグケース

Postmanとは異なり、ApidogではAPIとデバッグケースが明確に区別されています。各APIには複数のデバッグケースを紐付けることができ、APIのURLやパラメータを更新した場合、関連するすべてのデバッグケースも自動的に更新されます。追加の作業は一切必要ありません。

一方、PostmanではすべてがRequestであり、各Requestは独立しているため、APIのURLやパラメータ名が変更された場合、すべてのRequestを手動で修正する必要がある。

デバッグケースの作成

APIの実行タブでリクエストを送信やデバッグする際、そのリクエストを永続的に保存したい場合は「ケースとして保存」をクリックします。これにより、リクエストがAPI構造内のデバッグケースとして保存されます。

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

先に述べたように、API仕様はAPI内に保存され、値はデバッグケースに保存されます。具体的に、デバッグケースには以下のデータが含まれます：

リクエストパラメータの値, （パスパラメータ、クエリパラメータ、ヘッダーパラメータ、form-data形式のボディパラメータ）

RAW、JSON、XMLなどの形式のボディ内容

リクエスト前後の処理.

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

レスポンス検証設定（検証を有効にするかどうか、どのレスポンスと照合するか）

そのため、API仕様でパラメータの仕様を変更すると、デバッグケースもリアルタイムで更新されます。

デバッグケースは、自動テストシナリオ内のステップとして参照することが可能です。参照された場合、デバッグケース内のリクエストパラメータがそのままステップに適用されます。また、デバッグケースに変更を加えると、それを参照しているすべてのステップが自動的に更新される旨が明確に通知されます。

右上の参照アイコンをクリックすると、そのデバッグケースを参照しているテストシナリオと、使用している総数が表示されます。これにより、自動テストでの使用状況が把握できます。

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

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

API仕様を綿密に定義する

各APIに対して、異なる条件をカバーする複数のデバッグケースを作成する

各デバッグケースに対して、アサーションやその他のリクエスト前後の処理を書く

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

API仕様に変更があった場合でも、デバッグケースおよびテストシナリオの両方を同期させることができます。テストシナリオの更新は手動で行うことも、自動で反映させることも選択可能です。