VSCodeのREST ClinetプラグインでRESTのテストをする方法
RESTのテストはよくPOSTMANで実施していましたが、VSCodeのREST Clientプラグインも便利です。
curlコマンドをエディターで実行してくれます。
ファイルにURLを貼り付けるだけで、ファイルの拡張子はhttpとします。
GETかPOSTを指定してからURLを指定します。HTTP1.1を指定します。
URLの上にSend Requestと表示されるのでクリックするとAPIが実行されます。
header情報を付加する場合
header情報を付加するには、URLの1行したにheader情報を追記します。
以下はAPI GatewayのAPIキー情報をヘッダに付加した例です。
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| POST https://example.com/v1/users HTTP/1.1 | |
| x-api-key: 99xcGdJkyi1t33J8KIscL1peEotukhjz4hhPquxx |
POSTでリクエストボディを設定する場合
POSTの場合はリクエストボディを送りたいと思います。
方法は以下の通り、content-type: application/jsonと記述します。
1行空けてから、JSON形式を記述します。
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| PUT http://localhost:8080/hoge-0.0.1-SNAPSHOT/employees/12345 | |
| Content-Type: application/json | |
| { | |
| "id": "12345", | |
| "name": "takahashi" | |
| } |
1ファイルで複数のテストをしたい場合
1ファイルで一つのAPIしかテストができないとなるとイケてないです。区切り文字を挿入することで複数APIのテストができます。
APIとAPIの間に###を挿入します。
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| POST https://example.com/v1/users HTTP/1.1 | |
| ### | |
| POST https://example.com/v2/users HTTP/1.1 |
POSTMANと同等のことがVSCodeでできてしまいます。
KHI入社して退社。今はCONFRAGEで正社員です。関西で140-170/80～120万から受け付けております^^
得意技はJS(ES6),Java,AWSの大体のリソースです
コメントはやさしくお願いいたします^^
座右の銘は、「狭き門より入れ」「願わくは、我に七難八苦を与えたまえ」です^^
コメント