cURLコマンドでJsonをPOSTする方法

APIテストの際には、JSONデータを使用してデータを送信することがよくあります。そして、cURLは、APIテスト定番のコマンドツールとして、cURLコマンドでJsonデータを送信するには、どうしたらいいですか？本文では、cURLコマンドを使って、JSONデータをPOSTする方法を紹介します。

他の方法でJSONをPOSTしてみたい方は、こちらの関連記事をもお読みください：

超簡単：APIエンドポイントにJSONをPOSTする

一部のAPIエンドポイントに情報を渡すために、JSONフォーマットを使用する必要があります。それでは、APIエンドポイントにJSONをPOSTするには、どうしたらいいですか？本文では、簡単にJSONをAPIにPOSTする方法を皆さんに紹介します。

Apidogブログ - Apiに関する先端知識を取得するshimizu chioka

cURLとは

CURLとは、コマンドラインからHTTPリクエストを送信するためのオープンソースのライブラリやツールのことです。CURLはAPIテストにおいて重要なツールとして広く利用されています。Curlは、主に次のことを実現できます：

• さまざまなプロトコル(HTTP、HTTPS、FTP、SMTP等)に対応している
• GETやPOSTなどのリクエストメソッドを簡単に指定できる
• ヘッダーやリクエストボディのカスタマイズが簡単
• SSL/TLSによる暗号化通信に対応
• プロキシ経由の通信に対応
• リダイレクト、認証、Cookieの処理に対応
• レスポンスのヘッダやボディを表示できる

完全ガイド：Curlとは、使い方を完全に解説

日常的にAPIを取り扱うことが多い場合は、Curlというものをきっと聞いたことがあるのでしょう。それでは、Curlと何ですか？Curlをどうやって使用すればいいですか？本文では、こういう質問に対して、完全に解説していきたいと思います。

Apidogブログ - Apiに関する先端知識を取得するshimizu chioka

JSONとは

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

JSONのデータ構造

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

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

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

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

cURLでJSONをPOSTする

JSONデータは、POSTリクエストで送信する場合によく利用されています。それでは、定番のAPIテスト用のコマンドラインツールのcURLでAPIをテストする時に、どのようにJSONデータをPOSTすれば良いのしょうか？次はその詳細のガイドを皆さんに紹介していきたいと思います。

HTTPメソッドをPOSTに指定

POSTリクエストを送信するには、cURLの-Xオプションを使ってリクエストメソッドをPOSTに指定します。基本的な形式は以下です。

curl -X POST [URL]

Content-typeをJsonに指定

JSONデータをPOSTする場合は、-HオプションでContent-Typeを指定します。

curl -X POST https://example.com/api -H 'Content-Type: application/json' 

具体のJSONデータを記述

また、POSTリクエストではリクエストボディを送信することができます。-dオプションを入力して、その後に具体的なJSONデータを入力します。

curl -X POST https://example.com/api -H 'Content-Type: application/json' -d '{"name":"John", "email":"john@example.com"}'

このように、cURLはコマンドラインから簡単にJSONデータをPOSTリクエストで送信できます。リクエスト方法の指定やデータの送信などを柔軟に行うことができます。

ApidogのGUIで簡単にJSONデータをPOST

cURLコマンドツールの使い方をよく知っている方は、cURLを利用して、簡単にJSONデータをPOSTすることができますが、それを使い慣れていない方にとって、cURLというコマンドラインベースのツールは使い勝手がそんなによくないと思っているかもしれません。

そこで、日本語対応のGUIAPI管理ツールであるApidogを皆さんに紹介します。Apidogは非常に直感的なUIで、簡単にHTTPメソッド及び送信データの形式を選択することができます。また、APIの設計、仕様書生成、APIのテスト、モックなどのAPIライフサイクル管理の機能をも備えているので、API関連の作業なら、Apidogというツールを使えば簡単に処理できます。

このように、ApidogでAPIリクエストを送信する時に、HTTPメソッドをPOSTに指定した上、Bodyタブに切り替えて、JSONに指定しれば、JSONのデータを入力するだけで簡単にJSONをPOST送信できます。

まとめ

cURLはコマンドラインからHTTPリクエストを送信できる汎用的なツールになり、JSONはWeb APIなどでデータ交換によく利用されるフォーマットになります。cURLの-X POST、-H、-dオプションを使ってJSONデータをPOSTできますが、ApidogというGUIベースのツールを使えば、より直感的にJSONのPOSTが行えます。

cURLを使ってJSONを扱うスキルは、Webアプリ開発やAPIテストの現場で活用できるでしょう。開発環境に合わせてコマンドラインとGUIの両方を上手く利用していきましょう。