REST API クライアント

環境、コレクション、履歴を使って HTTP・GraphQL・WebSocket リクエストを送信します。

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

リクエストを送信する

  1. コマンドパレットから DevSnip Pro: REST API Client を実行するか、サイドバーでクリックします。
  2. メソッドを選び、URL を入力して Enter を押すか Send をクリックします。
  3. レスポンスを確認します:ステータス、時間、サイズ、検索できる整形済み JSON、ヘッダー、Cookie。ツールバーからコピーや保存ができます。
ヒント

cURL コマンド(たとえばブラウザーの開発者ツールの Copy as cURL)を URL バーに貼り付けると、メソッド、ヘッダー、ボディがインポートされます。

固定のホストやトークンの代わりに環境を使う

local や staging のように接続先ごとに環境を作り、baseUrl や token などの変数を設定します。リクエストのどこでも {{name}} で参照でき、環境を切り替えれば同じリクエストを別のサーバーに対して実行できます。

Request
GET {{baseUrl}}/users/42
Authorization: Bearer {{token}}

認証

Auth タブで Bearer、Basic、API key を選びます。OAuth 2.0 のトークンヘルパーは高度なツールとして利用できます。

コレクションと履歴

  • リクエストを コレクション に保存し、API の構造に合わせたフォルダー(auth/、users/、billing/)で整理します。コレクションは無制限で、ローカルに保存されます。
  • 履歴 には送信したすべてのリクエストが残ります。認証情報らしき URL の値は伏せられ、API キーが履歴に書き込まれることはありません。

GraphQL API をテストする

  1. プロトコルを HTTP から GraphQL に切り替えます(リクエスト名の横)。Body タブが Query タブになります。
  2. メソッドを POST にし、{{baseUrl}}/graphql のようにエンドポイントを入力します。
  3. クエリを書き、Variables (JSON) を追加します。ドキュメントに複数のオペレーションがある場合は Operation name も指定します。
  4. Ctrl/Cmd+Enter を押すか Send をクリックし、レスポンスの data と errors の両方を確認します。
Query
query GetCountry($code: ID!) {
  country(code: $code) {
    name
    capital
  }
}
例:変数とレスポンス

$code の値を Variables (JSON) に入れます:

Variables
{
  "code": "GB"
}

返ってくる data はクエリと同じ形をしています。GraphQL サーバーはクエリの一部が失敗しても 200 OK を返し、問題を errors 配列に列挙することが多いので、両方を確認しましょう:

Response
{
  "data": {
    "country": {
      "name": "United Kingdom",
      "capital": "London"
    }
  }
}

リクエストをコードに変換する

  • JavaScript(fetch、Axios)、Python、Go、Java、C# のコードを生成します。
  • README やバグ報告用に cURL としてエクスポートします。
  • JSON to Types でレスポンスから型を生成します(TypeScript、Zod、Pydantic、Go、Kotlin、Swift など)。

AI プロバイダーを呼び出す

OpenAI、Anthropic、Gemini、Azure OpenAI、Ollama、そして OpenAI 互換のあらゆるエンドポイント向けのリクエストテンプレートを用意しています。プロンプトを送り、返答をストリーミングで受け取り、スキーマで検証できます。API キーはリクエストにのみ使われ、保存されることはありません。

高度なツール

アサーション、リクエストの連鎖、一括パフォーマンス計測、レスポンスの比較、モックサーバー、WebSocket、OAuth 2.0 ヘルパー、型付き SDK のエクスポートは、成功した実行 1 回につき 8〜35 ポイントかかります。ポイントは拡張機能を使うと貯まります。ポイント、マイルストーン、テーマをご覧ください。

メモ

リクエストは devsnip.apiTimeout(既定値は 30 秒)でタイムアウトします。クライアントでリクエストごとに設定したタイムアウトがこれより優先され、Cancel でリクエストを途中で止められます。