VS Code で REST API をテストする方法

著者:Sayaib Sarkar更新日:5 分で読めます

このページの内容 7 セクション

要点:REST クライアントの拡張機能をインストールし、コードの横で開いてリクエストを送りましょう。このガイドでは DevSnip Pro の無料の REST API クライアントを使います。アカウント不要で、環境、コレクション、cURL のインポート、コード生成に対応しています。ここで紹介する習慣は、どのクライアントでも役立ちます。

VS Code の DevSnip Pro REST API クライアント:GET リクエストと整形済み JSON レスポンス、ステータス、時間、サイズ

エディターと別の API ツールを行き来するコストは、思った以上に大きいものです。コードから URL をコピーし、.env ファイルからトークンを貼り付けて送信し、型やテストを書くために JSON をコピーして戻す。VS Code の中なら、コード、リクエスト、レスポンスがすぐ隣にあります。

1. 最初のリクエストを送る

  1. コマンドパレット(Ctrl/Cmd+Shift+P)から DevSnip Pro: REST API Client を実行するか、DevSnip Pro のサイドバーでクリックします。
  2. Send a sample request をクリックします。無料の公開テスト API である GET https://jsonplaceholder.typicode.com/todos/1 を送信します。
  3. レスポンスパネルには、ステータス、時間、サイズ、検索できる整形済みの JSON、ヘッダーと Cookie が表示されます。

自分の API なら、URL を入力して Enter を押します。リクエストを cURL コマンドとして持っている場合(ブラウザーの開発者ツールの Copy as cURL)は、URL バーに貼り付けるとメソッド、ヘッダー、ボディがインポートされます。

2. ホストやトークンを直接書くのをやめる

local や staging のように接続先ごとに環境を作り、baseUrl や token などの変数を設定します。そのうえでリクエストを次のように書きます:

コード
GET {{baseUrl}}/users/42
Authorization: Bearer {{token}}

環境を切り替えれば同じリクエストを別のサーバーに対して実行でき、保存するリクエストにシークレットが残りません。

3. また実行するものは保存する

リクエストをコレクションに保存し、API の構造に合わせたフォルダー(auth/、users/、billing/)で整理します。履歴には送信したものがすべて残り、認証情報らしい URL の値は伏せられます。保存したリクエストは、プロジェクトに次に加わる人にとって生きたドキュメントになります。

4. `200 OK` だけでなく、異常系をテストする

ボディが間違っている 200 もバグです。触ったエンドポイントごとに、次を確認しましょう:

  • 形:フィールドがそろっているか、型は期待どおりか、名前は一貫しているか。
  • 不正な入力:必須フィールドの欠落や型の誤りには、スタックトレース付きの 500 ではなく、わかりやすい 4xx を返すべきです。
  • 認証:期限切れ、または存在しないトークン。JWT Decoder & Signer で、過去の exp を持つテスト用トークンに署名できます。
  • 存在しないリソース:役に立つメッセージ付きの 404。
  • ヘッダー:Content-Type、キャッシュ関連のヘッダー、ブラウザーから呼ばれるなら CORS のヘッダー(CORS Builder & Debugger が CORS エラーを説明します)。
  • 時間:ローカルで 900 ms かかるエンドポイントが、本番で速くなることはありません。

同じフィールドを 3 回確認したら、送信のたびに実行されるアサーションにしたり、リクエストを連鎖させたり(ログイン → 作成 → 確認)、一括実行でレイテンシーのパーセンタイルを確認したりしましょう。これらの高度なツールは、拡張機能を使って貯めたポイントで利用できます。購入するものは何もありません。

5. リクエストをコードと型に変換する

リクエストが動いたら、JavaScript(fetch または Axios)、Python、Go、Java、C# のコードを生成するか、README やバグ報告用に cURL としてエクスポートします。レスポンスから型を得るには、ツールサイドバーから JSON to Types を開きます:TypeScript、Zod、Pydantic、Kotlin、Swift、Dart、Java、Go、JSON Schema。

仕様書から作業していますか?OpenAPI / Swagger Toolkit は仕様をチェックし、すべてのエンドポイントを一覧表示して、TypeScript の型、fetch クライアント、cURL コマンドを生成します。

6. リリース前にデータベースとセキュリティを確認する

まとめ

ステップ重要な理由
環境1 つのリクエストで複数のサーバー。保存したリクエストにシークレットが残らない
コレクション繰り返せるチェックと共有される知識
異常系契約やエラー処理のバグを見つけられる
コードと型URL や JSON を手でコピーしなくて済む
セキュリティスキャン設定ミスのヘッダーは、リリース前なら簡単に直せる

自分のエディターで試してみよう

無料・アカウント不要・ローカルで動作。Windows、macOS、Linux の VS Code 1.93 以降と JetBrains IDE に対応。

code --install-extension sayaib.hue-console