Apidog クライアントは、HTTP、GraphQL、SOAP、gRPC、およびその他の一般的なプロトコルによる API リクエストの送信をサポートしています。Apidog でリクエストを作成し、送信してレスポンスを確認し、チームで共同作業するために保存できます。新しいリクエストを作成する#
Apidog でリクエストを作成するには、「+」 → 「New Request」 をクリックするだけです。リクエストメソッド、URL、リクエストパラメータ、認証など、API 仕様に従ってリクエストに必要な項目を Apidog のインターフェースに入力できます。この方法を使用すると、HTTP、GraphQL、SOAP リクエストを作成できます。WebSocket および gRPC リクエストの作成について詳しくは、それぞれのプロトコルのドキュメントを参照してください。リクエスト URL#
Apidog でリクエストを行うには、接続先の API エンドポイントを表す URL を指定する必要があります。API を使用して実行できる各操作は通常、特定の URL を持つエンドポイントに関連付けられています。API を構築している場合: URL は通常、ベースの場所とパスで構成されます。たとえば、リクエスト URL https://api.example.com/user/12 では、https://api.example.com がベース URL で、/user/12 がエンドポイントパスです。
公開 API を使用している場合: API プロバイダーが、開発者向けドキュメントで必要な URL を提供します。
プロトコルを指定しない場合、Apidog は URL の先頭に http:// を自動的に追加します。
リクエストメソッド#
Apidog では、リクエスト URL の左側で使用するリクエストメソッドを選択できます。デフォルトのメソッドは GET です。一般的な HTTP メソッド#
| メソッド | 目的 | データへの影響 |
|---|
| GET | 指定したリソースからデータを取得する | 読み取り専用で、副作用はありません |
| POST | 処理するデータを指定したリソースに送信する | 新しいリソースを作成します |
| PUT | 既存のリソースを更新する | リソース全体を置き換えます |
| PATCH | リソースに部分的な変更を適用する | 特定のフィールドを更新します |
| DELETE | リソースの削除をリクエストする | リソースを削除します |
API 設計では、同じ URL に対して異なるメソッドでリクエストでき、同じリソースに対する異なる操作を表します。たとえば、GET /user/{id} は通常、この id のユーザー情報を取得し、PUT /user/{id} はこの id のユーザー情報を更新します。リクエストを送信する#
リクエストのプロトコル、メソッド、URL を指定したら、リクエストの送信先 API に必要なその他の詳細を追加します。パラメータとボディ: リクエストとともに送信する必要があるパラメータ、ボデ ィデータ、またはリクエストヘッダーを指定します。
Cookies: Cookies タブを選択することで、リクエストで Cookie を使用することもできます。
サイドバーの History で送信済みのリクエストを確認し、再送信できます。これは、デバッグや時間の経過に伴うレスポンスの比較に役立ちます。
