【Curlコマンド】 忘れがちなAPIの動作確認の方法

本記事の目的

アプリ開発をしているとサーバサイドでAPIを開発する機会が多いと思います。
また外部サービスともAPIを通じて連携する機会も多いと思います。
備忘録も兼ねてAPIの疎通を確認する際に使用するCurlコマンドについて記載していきます。

おまけになりますがLaravelでのBearerトークンの受取る方法なども記載しております。

基礎：POSTリクエスト

# -X POSTを指定することでPOSTでリクエストすることが出来ます。
# -d パラメータを指定することが出来ます。(複数のパラメータを指定する場合は&で繋ぐこと)
$ curl -X POST https://hogehoge/api/v1/sample -d "name=tester&age=24"

基礎：GETリクエスト

# -X GETを指定することでGETでリクエストすることが出来ます。
$ curl -X POST https://hogehoge/api/v1/sample?name=tester&age=24

基礎：HTTP Headerを指定する

# -H HTTP Headerを付与することが出来ます。(複数ある場合は-Hを複数記載する)
$ curl -X POST 'https://hogehoge/api/v1/sample' -H 'Content-Type: application/json;charset=utf-8' -H 'Accept-Charset: utf-8'

基礎：Bearer Tokenを指定する

$ curl -X POST 'https://hogehoge/api/v1/sample' -H 'Content-Type: application/json;charset=utf-8'  -H 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

基礎：JSONパラメータを指定する

$ curl -X POST 'https://hogehoge/api/v1/sample' -H 'Content-Type: application/json;charset=utf-8' -d '{"name":"tester", "age":"24"}'     

応用：Bearer Token + JSONパラメータを指定する

$ curl -X POST 'https://hogehoge/api/v1/sample' -H 'Content-Type: application/json;charset=utf-8'  -H 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxx' -d '{"name":"tester", "age":"24"}'

豆知識：[Laravel] Bearer Tokenの取得方法

# HTTPヘッダーからBearer Tokenを取得する。
$bearer_token = $request->bearerToken();

豆知識：[Laravel] パラメーターの取得方法

# パラメーターを取得する。
$name = $request->name;
$age = $request->age;