#はじめに
VSCodeでリクエストの送信、確認ができるプラグインがあるとのことで触ってみました
備忘録として書いてます
#目次
- REST Clientとは
- 基本的な書き方
- GET
- POST
- 基本的な書き方
- SendGridでメールの確認
- 終わり
- 参考
##REST Clientとは
VSCodeの拡張機能です
PostmanのようなことがVSCode上でできます
使うにはVSCodeの拡張機能からインストールするだけです
こちらのサイトを参考にしました
###基本的な書き方
REST Clientをインストールしたら、HTTP接続の内容を書くための「.http」ファイルを作成します
作成したファイルにGET、POST等書いていき、「Send Request」を押下でリクエストを送信、確認できます
問題なければ200、エラーがあれば400などの表示がでます
また、「###」を挟んで複数のリクエストを一つのファイルに記載することもできます
####GET
GET http://localhost:8080/ HTTP/1.1
GET URL の書き方、もしくはGETを省略してURLだけで記載するとGETできます
@hostname = localhost
@port = 8080
@host = {{hostname}}:{{port}}
GET http://{{host}}/
上記のように変数を使うこともできます
変数の説明はこちらのサイトに詳しく書いてありました
####POST
POST http://localhost:8080/sample HTTP/1.1
content-type: application/json
{
"id": "1000000",
}
POSTの場合はPOST URL、content-typeに一行開けてリクエストボディを記載します
上記例はcontent-typeでJSON形式を指定しているのでこの書き方ですが、
他にもxml形式など指定ができるようです(こちらのサイトが詳しく書いてあります)
##SendGridでメールの確認
SendGridはクラウドのメール配信サービスです(公式)
テストなど、個人での利用は無料で使うことができます(登録、審査が必要)
このSendGridとREST Clientを用いてAPI呼び出しの確認ができる記事があったので参考にしてやってみました
@APIキー=xxxxxxxxxxxxxxxx
POST https://api.sendgrid.com/v3/mail/send HTTP/1.1
Authorization: Bearer {{APIキー}}
Content-Type: application/json
{
"personalizations": [
{
"to": [{"email": "MailSlurpで発行したメールアドレス"}]
}
],
"from": {"email": "sender@example.com"},
"subject": "メール件名",
"content": [
{
"type": "text/plain",
"value": "メール本文"
}
]
}
↑↑ほとんど参考サイトそのままです
SendGridに登録、入手できるAPIキーを記載して、JSON形式で書いています
送信先のメースアドレスには以前触ったことがあるMailSlurpのアドレスにしてみました
「Send Request」で200の確認とMailSlurpにメールが届いていることが確認できました
##終わり
まだ使いこなせてはいませんが、使い方の雰囲気は分かったかな、といった具合です
##参考
https://qiita.com/toshi0607/items/c4440d3fbfa72eac840c