パラメータとボディ

APIを使用する際、リクエストで様々なタイプのデータを送信する方法を理解することが重要だ。Apidogは、異なるパラメータとボディデータタイプを持つAPIリクエストの構築と送信を支援する使いやすいインターフェースを提供する。

パラメータ

パラメータを使用すると、サーバーに追加情報を送信できる。Apidogは、クエリパラメータとパスパラメータの2つの主要なタイプをサポートしている。

Queryパラメータ

クエリパラメータはURLの末尾に疑問符（?）の後に追加され、アンパサンド（&）で区切られる。サーバーにオプションまたは追加データを送信するために使用される。Apidogでは、APIリクエストのクエリパラメータを簡単に追加・管理できる。

クエリパラメータを追加する方法は2つある：

URLに直接追加：アドレスバーのURL末尾に直接クエリパラメータを追加できる。
例：

https://api.example.com/users?page=1&limit=10

Queryパラメータセクションを使用：ApidogはURL入力フィールドの下に専用のクエリパラメータセクションを提供する。ここで使いやすいインターフェースを使用してパラメータの追加、編集、削除ができる。このセクションで追加したパラメータは自動的にリクエストURLに追加される。

クエリパラメータの等号

特殊なケースでは、クエリパラメータがキーと値のペアとして表示されないことがある。例えば：

https://api.example.com/users?available

この場合、available は空の値を持つパラメータとして機能する。値が空の場合、Apidogはキーと値の間の等号を自動的に省略する。

等号を省略したくない場合は、手動で「等号を追加」に変更できる。

Path パラメータ

パスパラメータはURL自体の一部で、通常特定のリソースを識別するために使用される。URLで中括弧{}で囲まれたプレースホルダーで示される。

例：

https://api.example.com/users/{userId}

Apidogでは、上記のようにAPI URLでパスパラメータを定義でき、それらは下のパスパラメータセクションに表示される。パスパラメータセクションで値を入力し、リクエスト送信時に {param} が実際の値に置き換えられる。この機能は、URLでリソース識別子を使用するRESTful APIのテストに特に役立つ。

パスパラメータで変数を使用する場合、URLで {param} を使用し、パラメータの値で {{変数}} を使用することを推奨する。

Body

リクエストボディは、POST、PUT、またはPATCHリクエストの一部としてサーバーにデータを送信するために使用される。Apidogは様々なボディデータ形式をサポートし、異なるAPI要件に対応する。

Form-Data

form-dataは、HTMLフォームの送信に似たキーと値のペアを送信する方法だ。この形式は、ファイルを他のデータと共にアップロードする必要がある場合に特に便利。

form-dataタイプのボディはリクエストで multipart/form-data として表示される。ボディの各パラメータについて、文字列、整数などのタイプを選択できる。

form-dataでJSONを送信する必要がある場合は、パラメータタイプを文字列に設定し、文字列フィールドにJSONを入力する。

リクエストでファイルを送信する場合は、タイプをファイルとして選択し、「アップロード」をクリックしてローカルファイルを選択する。

Apidogはリクエストでファイルを送信するだけで、クラウドにファイルを保存しない。そのため、チームでの協業時、他のメンバーはこのリクエストを見ることはできるが、直接このファイルを送信することはできない。同僚がファイルを送信できるようにするには、別の手段でファイルを転送する必要がある。

x-www-form-urlencoded

この形式はクエリパラメータに似ているが、リクエストボディで送信される。ファイルアップロードのない単純なフォームの送信によく使用される。Apidogでは、キーと値のインターフェースを使用してx-www-form-urlencodedデータを簡単に追加・編集できる。

JSON

JSONは、APIのリクエストおよびレスポンスで広く利用されているデータフォーマットです。APIの 「Request → Body → JSON」 セクションで、データスキーマを設計できます。

JSONデータスキーマを設計する際には、ApidogのJSONなどから生成機能を活用することで、各フィールドを手動で追加する手間を省き、スキーマを迅速に作成できます。

フィールドを手動で追加する場合、デフォルトのデータ型は「string」となります。ネストされたフィールドを追加する必要がある場合は、フィールドタイプを「object」または「array」に変更してください。

XML

XML（eXtensible Markup Language）はAPI通信で使用される別の一般的なデータ形式だ。ApidogはXMLペイロードをサポートし、APIリクエストで構造化されたデータをXML形式で送信できる。

raw

rawオプションでは、リクエストボディで任意のカスタムデータ形式を送信できる。他のオプションでカバーされていない特定のデータ構造や形式を期待するAPIで作業する場合に便利。

binary

バイナリデータはこのオプションを使用して送信でき、ファイルのアップロードやバイナリペイロードを期待するAPIとの作業時に特に便利。Apidogでは、APIリクエストの一部としてバイナリファイルを選択・送信できる。

GraphQL

GraphQLを使用するAPIでは、Apidogは専用のGraphQLエディタを提供する。この機能により、構文強調とオートコンプリート機能を備えたGraphQLクエリとミューテーションを構築・送信できる。

詳細については、ApidogのGraphQLを参照。

msgpack

MessagePack（msgpack）はJSONよりもコンパクトで高速なバイナリシリアライゼーション形式だ。Apidogはmsgpackデータの送信をサポートしており、パフォーマンスとデータ転送の削減に最適化されたAPIで作業する場合に有効。

パラメータとボディ