PostmanでJSONデータを送信する方法

APIの開発プロセス中に、しばしばJSONデータを使用してAPIのデータを転送したりしています。Postmanという有名なAPIテストツールを使って、JSONデータに完璧に対応しているので、本文では、PostmanでJSONデータを送信する方法を皆さんに紹介します。

JSONとは

JSON（JavaScript Object Notation）は、データの表現と交換に使用される軽量なデータ形式です。JSONは人間にとって読みやすく、コンピュータにとってもパースや生成が容易であるため、広く利用されています。

JSONのデータ構造

JSONは、キーと値のペアのコレクションを含むテキストベースのデータ形式です。データは、以下の形式で表現されます。

{
  "キー1": "値1",
  "キー2": "値2",
  "キー3": "値3"
}

キーはダブルクォートで囲まれ、値は文字列、数値、真偽値（true/false）、配列、またはネストされたJSONオブジェクトのいずれかです。配列は角括弧（[ ]）で囲まれ、複数の値をカンマで区切って表現します。

JSONは、ウェブアプリケーションやサーバーとの間でデータのやり取りに広く使用されています。多くのプログラミング言語でJSONのパースや生成をサポートしており、データのシリアライズやデシリアライズに利用されます。また、Web APIでは、クライアントとサーバー間でJSONデータを送受信することが一般的です。

Postmanは、JSONデータに完璧に互換できるので、次は、Postmanを使ってJSONデータを送信する詳細な方法を紹介します。

PostmanでJSONデータを送信する手順

⒈Methodの設定

APIの通信方式を設定します。JSONのデータは、Body経由で転送します。通常、PostmanでJSONデータを送信する時、メソッドをPOSTにすることが多いのです。

Bodyに対応できるHTTPメソッドは：

• POST：リソースの追加、通常Bodyに新しいデータが含まれます。
• PUT：リソースの更新、通常Bodyに既存データの上書き用のデータが含まれます。
• PATCH：リソースへの部分的な変更の適用、通常Bodyに更新したいフィールドとその値が含まれます。

ご注意：GETとDELETEメソッドもBodyをサポートできるが、実際の開発プロセス中に、これらのメソッドを使用することが少なくなっています。

⒉Pathの設定

APIのエンドポイントとなるURLを記入します。

⒊Headerの設定

HeaderでContent-Type：application/jsonを追加します。この設定は、送信するデータ（Bodyのコンテンツ）のフォーマットをJSONと指定します。

⒋Bodyの設定

Bodyのタイプをrawにして、その右にあるドロップリストからJSONを選択します。そして、下のテキストフィールドで送信したいJSONデータを入力します。

⒌Requestの送信

画面の右上にある「Send」ボタンをクリックして、JSONデータを送信します。

ここでPostmanを使って、JSONデータを成功に送信しました。

日本語対応のApidogでもJSONデータに完璧に対応

PostmanはAPI開発中の単体テストなどの場合でよく使われるツールですが、日本語に非対応なので、国内のユーザーはそのツールを効率的に利用できない可能性があります。そこで、日本語対応のApidogというAPI管理ツールを皆さんに紹介します。ApidogはPostmanより機能が強く、制限が少ないツールとして、APIの設計、仕様書生成、APIのテスト、モックなどのAPIライフサイクル管理の機能をも備えています。Postmanのようなコレクションを作成して、APIテストの自動化もサポートされています。

Apidogでは、HeaderにContent-Typeのキーと値のペアを追加する必要がなく、BodyのタイプをJSONに指定して、JSONのデータを入力するだけで、簡単にJSONを送信できます。