Apidog Docs

APIケース

Postmanとは異なり、Apidogは「API」と「APIケース」に分かれている。1つのAPIには複数のAPIケースが存在する。API内のURLやパラメータが変更されると、すべての用例が自動的に同期されて修正される。
一方、PostmanではすべてがRequestであり、各Requestは独立しているため、APIのURLやパラメータ名が変更された場合、すべてのRequestを手動で修正する必要がある。

APIケースの作成

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

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

APIケースに保存される内容

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

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

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

リクエスト前後の処理.

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

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

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

自動テストのステップとしてAPIケースを参照

APIケースは自動テストシナリオのテストステップとして参照できます。参照すると、APIケースのリクエストパラメータがテストステップに直接適用されます。APIケースを変更すると、それを参照しているすべてのテストステップが自動的に更新される旨が明確に通知されます。

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

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

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

APIケースの活用ベストプラクティス

1.

API仕様を綿密に定義する

2.

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

3.

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

4.

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

5.

API仕様が更新された場合、APIケースとテストシナリオの両方を同期できる。テストシナリオを手動で更新するか、自動更新するかを選択できる

コード生成機能