リクエストの基本

Apidogクライアントは、HTTP、GraphQL、SOAP、gRPCなどの一般的なプロトコルを使用したAPIリクエストの送信に対応している。Apidogでリクエストを作成し、送信してレスポンスを確認し、チームでの共同作業用に保存できる。

新規リクエストの作成

Apidogでリクエストを作成するには、「+」-「新しいRequest」をクリックするだけでいい。

API仕様に従って、リクエストメソッド、URL、リクエストパラメータ、認証情報などの必要な情報をApidogインターフェースに入力できる。

この方法で HTTP、GraphQL、SOAP リクエストを作成できる。WebSocket と gRPC リクエストの作成についての詳細は別途参照。

Apidogでリクエストを行うには、接続先のAPIを表すURLを指定する必要がある。APIを使用して実行できる各操作には、通常特定のURLを持つAPIが関連付けられている。

APIを構築する場合、URLは通常ベースロケーションとパスで構成される。例えば、リクエストURL https://api.example.com/user/12 では、https://api.example.com がベースURL、/user/12 がAPIパスとなる

公開APIを使用する場合、API提供者が開発者ドキュメントで必要なURLを提供する

クエリパラメータはURLフィールドで入力するか、パラメータタブで入力できる。パスパラメータを使用する場合は、URLフィールドで入力する。クエリパラメータ/パスパラメータについて詳しく見る。

プロトコルを指定しない場合、Apidogは自動的にURLの先頭に http:// を追加する。

Apidogでは、リクエストURLの左側でリクエストメソッドを選択できる。デフォルトのメソッドはGETだ。以下が最も一般的なリクエストメソッド：

GET: 指定したリソースからデータを取得。データに影響を与えるべきではない

POST: 処理するデータを指定したリソースに送信。新しいリソースの作成によく使用される

PUT: 既存のリソースを更新。リクエストで送信されたデータでリソース全体を置き換える

PATCH: リソースに部分的な変更を適用

DELETE: リソースの削除を要求

API設計では、同じURLに対して異なるメソッドでリクエストを行うことで、同じリソースに対する異なる操作を表現できる。例えば、GET /user/{id} は通常このIDのユーザー情報を取得し、PUT /user/{id} はこのIDのユーザー情報を更新する。

リクエストのプロトコル、メソッド、URLを指定した後、APIに送信するリクエストに必要な詳細を追加する：

リクエストと共に送信する必要があるパラメータ、ボディデータ、リクエストヘッダーを提供する

必要な認証と認可を設定する

Cookiesを選択してリクエストでCookieを使用することもできる

すべてのリクエストの詳細を入力したら、「送信」を選択してAPIサーバーにリクエストを送信する。レスポンスペインでサーバーからのレスポンスを確認できる。ApidogでのAPIレスポンス構造について詳しく見る。

サイドバーの履歴で送信したリクエストを確認し、再送信することができる。