Visual Studio CodeのREST Clientを使ってSendGridのメールを送信する

ハンズオンの講師を担当している菊田です。

SendGridのハンズオンでは、Web APIの実行にAPIリファレンスを利用しています。先日、試験的に、Visual Studio Codeとその拡張機能であるREST Clientを使用したところ、「手軽で良い」と好評だったため、今回はその手順をご紹介します。

環境準備

利用しているOSにあわせてVisual Studio Codeをインストールし、下図の手順で「REST Client」を追加してください。必要な環境はこれだけです。

HTTPファイルの利用

REST ClientではAPIのリクエスト内容が記載されたHTTPファイルを利用できます。ファイルの拡張子は「.http」です。

ハンズオンで利用したHTTPファイルを公開しています。こちらからダウンロードし、Visual Studio Codeで開いてください。

ファイルを開いたら、上図の手順でAPIを実行可能です。
まず、認証情報のAPIキーを作成し、1行目の「SG.xxxxx」を上書きしてください。APIキーは全てのリクエストで必要なため、変数として定義して重複した記述を回避します。

続いて、宛先のメールアドレスを自分のものに変更し、「Send Request」をクリックしてメールを送信してください。

実行結果の確認

APIの実行結果は画面右側のエリアに表示されます。2xx系の応答コードが表示された場合はAPIの呼び出しに成功しているので、宛先にメールが届いているか確認してください。

さいごに

APIを呼び出す方法はcurlコマンドやPostmanなど様々なものがありますが、Visual Studio Code＋REST ClientではHTTPファイルを利用することで簡単にAPIを呼び出すことができます。

APIは様々な方法で実行することが可能です。今後も色々な送信方法を定期的に試していきたいと思います。