APIケース

APIケースはApidogならではの概念です。

PostmanなどのAPIテストツールと異なり、Apidogのデータは「コレクション」ではなく、API仕様をベースに整理されています。この構造は、API開発チームの作業スタイルにより適しています。

この違いにより、ApidogとPostmanでは情報構造が異なります。Postmanのコレクションでは、各要素がリクエストを表し、パラメータのキーと値のペアを含んでいます。

一方Apidogでは、API仕様の最小単位はAPI仕様で、スキーマやキーは含まれますが、実際のリクエスト値は含まれません。

これらの値と実際のリクエストを保存するため、ApidogではAPIの下にAPIケースという追加レベルを設けています。

APIケースはPostmanにおけるリクエストに相当します。

APIケースの作成

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

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

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

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

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

リクエスト前後の処理.

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

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

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

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

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

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

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

API仕様を綿密に定義する

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

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

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

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