今日は開発環境からPostmanをシームレスに利用可能にするPostman VSCode Extensionについて紹介します。
Postman VSCode Extension をやってみる
読んで字のごとくPostmanをVSCodeから使えるようにするものです。
使い方は簡単でVSCodeの拡張機能からインストールすればあとはいつものPostmanのように使えます。
インストールをクリックします。Postmanは人気のツールなのでVSCode拡張も有志によるものなど複数存在していますが今日は公式を使います。
以下のようなものもあるので開発者名を確認し正しいものを選んでください。
インストールが完了したらその他のビューでPostmanが出てきます。
初回起動時はまずログインが必要です。いつも通りPostmanのログインに使うクレデンシャルを入力します。
こんな感じでブラウザでログイン画面が出てきますのでログインします。
ログインするとCollections(APIコールの設定の塊）を呼び出しています。
あとはいつも通り使うだけです。
ここでTestするAPIコールはPostmanのクラウド環境から出ています。curlと異なりローカルから通信が出ていない点に注意してください。
現時点での制限
使える機能はCollectionsと環境変数を保存するEnvironmentのみです。ワークフローエンジンであるFlowsは未対応です。またHTTP,gRPC,WebSocketの３つののみ対応しておりGraphQL,Socket.io,MQTTは未対応です。
curlコマンドのインポート
この拡張機能ではcurlコマンドをもとにCollectionを作成してくれる機能が備わっています。
importボタンをクリックしてcurlを選択します。
例えば以下を貼り付けてSaveボタンを押すと
curl -X POST https://collection.requestcatcher.com/ \
-H "Content-Type: application/json" \
-d '{"key1":"value1", "key2":"value2"}'
Postman側にも反映されます。Postman本体もcurlコマンドをインストールする機能はあるのですが、curlを実行するためには環境切り替えが必要でした。このためcurlとPostmanを使い分けている人には便利な機能ではないでしょうか。