簡易的なAPIリクエストのテスト

はじめに

サーバ側やアプリ側の実装を行なっていると、連携するAPIのリクエスト確認を行いたくなる場合がある。
　→リクエストがうまくいかない　→ じゃあAPIリクエストの成功例ってなんだっけ？　→ 試しにCurlとかでAPIリクエストしてみるか、流れですね。

事前にAPIリクエストできることを確認してから、実装に入ることもあるので簡易的にAPIリクエストできる環境を整えることは結構大事です。

いくつか方法があるので、この辺りをつらつらと記載していきます。

方法

1. Postman

•	PostmanはGUIベースのAPIテストツールで、リクエスト作成やレスポンス確認が簡単に行えます。
•	GET、POSTなど各種リクエストを送信し、レスポンス内容やステータスコードを確認可能。

2. VSCodeのREST Client拡張

•	VSCodeの「REST Client」拡張機能を使うと、`.http`ファイルにAPIリクエストを書き込み、その場で実行・確認できます。
•	URLやメソッドを記述後、「Send Request」をクリックするだけで結果が表示されます。
•	GET, POSTなども行けるし、複数APIの連続実行もできる。なんなら変数を使って１つ目のAPIのレスポンスのパラメータを使用して、２つ目のリクエストボディに含めることだってできる☆ これマジで便利

↓この記事がめっちゃ分かりやすい
https://qiita.com/toshi0607/items/c4440d3fbfa72eac840c

3. Curlで確認する

•Macであれば標準でインストールされているはず
　$ curl --version
でcurlがインストールされていなければ、brewからcurlをインストールしましょう。
　$ brew install curl

curlが使えるようになれば、以下のようにテストできる
　$ curl https://weather.tsukumijima.net/api/forecast/city/400040

レスポンス
{
    "publicTime": "2025-01-07T17:00:00+09:00",
    "publicTimeFormatted": "2025/01/07 17:00:00",
    "publishingOffice": "福岡管区気象台",
    "title": "福岡県 久留米 の天気",
    "link": "https://www.jma.go.jp/bosai/forecast/#area_type=offices&area_code=400000",
    "description": {
  〜〜〜長いので以下省略〜〜〜

4. Macのショートカット.appを使用

えっ！？ショートカットアプリでAPIリクエストできるの？と思ったけど、調べたら出来るようです。
素直にツールを導入した方が良い気もしますが、セキュリティ的に色々な面倒な状況もあるため、MAC標準で出来る方法として紹介します。

Macのショートカットアプリを起動し、"新規ショートカット"を選択

"URLの内容を取得"を選択

以下はGETの例ですが、POSTも行けちゃう

※レスポンスのJSONが整形されていないのは残念ですが、
　目玉みたいなアイコンをクリックして、"Xcodeで開く"を選択すれば自動的に整形してくれるよ

以上