Apidog Docs

リクエストの送信

APIの実行 タブで 送信 をクリックしてリクエストを送信する。

APIの 実行 画面とRequest 画面はよく似ているが、主な違いは次の通り。実行 はAPI仕様に基づいてリクエストを生成し、レスポンスを検証できる。API仕様が変更されると、実行 画面も自動的に更新される。一方、Requestは独立していて、API仕様とは関連付けられていない。

リクエストの送信

リクエストを送信すると、APIサーバーからのレスポンスが確認、可視化、トラブルシューティングしやすい形で表示される。

画面は2つの部分に分かれている：

上部：送信したいリクエストを入力

下部：実際に送信されたリクエスト、受信したレスポンス、レスポンスの検証結果を表示

右下の分割 ボタンにカーソルを合わせると、画面レイアウトを調整できる。水平分割、垂直分割、分割なしから選択可能。

実際のリクエスト

上部で変数や動的な値、スクリプトなどを使用してリクエストを調整できる。実際に送信されるリクエストは、下部の 実際のリクエスト タブで確認できる。

レスポンスの検証

ApidogはAPI仕様に基づいて、レスポンスがスキーマに準拠しているかを自動的に検証する。検証の有効・無効の切り替えや、検証対象のレスポンスを選択できる。

詳しくはレスポンスの検証を参照。

レスポンスの抽出

レスポンスをAPI仕様に抽出できる。レスポンススキーマ または レスポンスサンプル として抽出可能。

リクエストの修正

実行 タブでリクエストを修正できる。パラメータの値を変更したり、チェックボックスで切り替えたりできる。これらの操作はAPI仕様と競合しない。

パラメータの型の変更や追加・削除が必要な場合、リクエストはAPI仕様から外れることになる。このような不一致はオレンジ色でハイライトされる。

ハイライトにカーソルを合わせると、仕様と現在のリクエストの違いが表示される。元に戻す で仕様に合わせた状態に戻すか、仕様に保存 で仕様を更新できる。右上の 不一致 ボタンで、すべての違いをまとめて元に戻すか仕様に保存できる。

リクエストの保存

実行 タブには保存ボタンがない。これは、API仕様にはリクエストの内容が含まれないためだ。

デバッグを容易にするため、Apidogは 一時保存 ボタンを提供している。一時保存をクリックすると、API仕様に影響を与えることなく現在の 実行 画面の内容が保存され、他の人との同期は行われない。

リクエストを永続的に保存したい場合は、テストケースとして保存 をクリックする。このリクエストはAPIのテストケースとして階層構造で保存される。

APIの各使用シナリオをテストケースとして保存でき、開発者のデバッグを支援し、自動テストのステップとして簡単にインポートできる。

詳しくはAPIテストケースを参照。

Postman Collectionをインポートする場合、各Postmanリクエストは、Apidogではテストケースに対応する。そのため、API仕様ではなく、API階層の下に成功ケースとして表示される。
詳しくはPostmanからの移行を参照。

Q&A

Q: 他のツール（Postmanなど）では同じリクエストが正常に動作するのに、Apidogでは動作しないのはなぜ？

A: リクエストが同一であれば、使用するツールに関係なくレスポンスも同一になるはず。レスポンスが異なる場合は、実際のリクエスト タブで他のツールで送信したリクエストと比較して、違いを確認してください。

Modified at 2025-01-21 09:07:05

リクエストの生成

コード生成機能