Apidog バージョン 2.7.29 以降、API詳細ページ上で直接テストケースを追加できるようになりました。各テストケースは、APIに対する一連のリクエストパラメータを表します。ユーザーはすべてのテストケースを体系的に整理・管理でき、ワンクリックで実行して現在のAPIのテストを完了できます。目的:APIがさまざまなリクエストシナリオで期待通りに動作するかを検証すること。網羅性を重視。
正常系、異常系、境界値、セキュリティなど、幅広いシナリオをカバー。
目的:開発やトラブルシューティング時にAPIのレスポンスを素早く確認すること。(スピード重視)
テストケースの作成方法#
1. 手動作成#
API詳細ページの「テストケース」タブで「+ケース追加」をクリックし、手動で作成します。2. デバッグケースからインポート#
テストケース追加時に「デバッグケースからインポート」を選択し、既存のデバッグケースをテストケースとしてコピーまたは移動できます。テストケースにコピー
デバッグケースを引き続き素早い検証に使いたい場合、同時にテストケースとしても利用したい場合に選択します。
テストケースに移動
デバッグケースが主に例外検証用で、今後デバッグ用途で頻繁に使わない場合に選択します。デバッグケースからテストケースへ直接変換されるため、 もともとデバッグケースとして作成していた場合の移行がスムーズです。
テストケースの詳細#
グループ:テスト目的(正常系、異常系、境界値など)ごとに整理
リクエストパラメータ:Path、Query、Header、form-data Body など
リクエストボディ:RAW、JSON、XML などに対応
レスポンス検証:検証の有効/無効切り替え、検証対象のレスポンス項目指定
※ テストケースは更新頻度が低いため、APIの仕様変更時は手動で同期が必要です。例えばAPIに新しいフィールドが追加された場合、テストケース内で「今すぐ同期」をクリックして内容を反映してください。テストケースの内容を編集した場合は、「保存」をクリックして保存してください。未保存の変更がある場合、システムから通知されます。テストケースの管理#
「テストケース」タブでは、作成済みのすべてのテストケースを管理できます。左上の検索・フィルター機能で目的のテストケースを素早く探せます。また、グループタブでグループごとに一覧表示も可能です。個別のテストケースに対しては以下の操作が可能です。単一テストケース:新しいタブで詳細を開き、閲覧・編集・実行が可能。コピー、他グループへの移動、cURLコピー、削除などの基本操作も用意されています。
複数テストケース:リストで複数選択すると、右上に一括操作ボタンが表示され、グループ分け・削除・API更新との同期などがまとめて実行できます。
テストケースの実行#
テストケース閲覧時に「実行」ボタンをクリックすると、そのパラメータでリクエストが送信され、実際のレスポンスが表示されます。「一括実行」や、リストから複数のテストケースを選択してまとめて実行することも可能です。画面上で、どのケースが実行中か、どのケースに結果があるかが一目で分かります。一括実行後は、各テストケースを開いて実行結果を直接確認できます。テストレポート#
テストを一括実行した後は、画面右上の「テストレポート」から過去のすべてのレポートを確認できます。レポートをクリックすると、詳細な実行結果を確認でき、問題の追跡や分析に役立ちます。単一APIテストのベストプラクティス#
単一APIのテストは、主にバックエンド開発者とQAエンジニアの2つの役割が関与します。バックエンド開発者:APIの実装およびデバッグを担当
QAエンジニア:APIの網羅的なテストと問題発見を担当
ApidogでAPIごとにテストケースを管理できるようになったことで、以下のような効率的なワークフローが実現できます。QAエンジニアはAPIドキュメント内で直接ユニットテストケースを作成・管理可能
開発者は既存のテストケースを用いて自らテストを実行し、結果を確認して即座に修正可能。QAエンジニアのフィードバックややり取りを待つ必要がありません
このワークフローにより、チームのコラボレーション効率が向上します。1.
APIドキュメント確定後、すぐにテストケースを作成でき、Apidog上で全メンバーが内容を確認可能
2.
開発者はデバッグ後、自分でAPIテストを実施でき、QAエンジニアの待機が不要
3.
テスト結果をもとに、開発者自身が直接修正可能。追加のチケット発行や手戻りが発生しません
4.
テスト結果が明確なため、問題の説明や認識違いが発生しにくくなります
Modified at 2025-09-18 10:44:35