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

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

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

要点:GraphQL のリクエストは、クエリ、変数、そして必要に応じてオペレーション名を含む JSON ボディを持った HTTP の POST です。GraphQL を理解する REST クライアントなら送信できます。このガイドでは DevSnip Pro の無料の REST API クライアントを使います。クエリ、変数、オペレーション名をそれぞれ入力できる GraphQL モードがあります。

1. クライアントを GraphQL に切り替える

  1. コマンドパレット(Ctrl/Cmd+Shift+P)から DevSnip Pro: REST API Client を実行します。
  2. プロトコルを HTTP から GraphQL に切り替えます(リクエスト名の横)。Body タブが Query タブに置き換わります。
  3. メソッドを POST にし、エンドポイントを入力します。たとえば https://countries.trevorblades.com/(公開のデモ API)や {{baseUrl}}/graphql です。

メソッドが GET の場合、クライアントはクエリが送信されないことを警告し、Use POST を提案します。

2. クエリと変数を書く

Query フィールドに:

GraphQL
query GetCountry($code: ID!) {
  country(code: $code) {
    name
    capital
    currency
  }
}

Variables (JSON) に:

JSON
{ "code": "DE" }

変数フィールドは入力中にチェックされるので、無効な JSON は送信前に指摘されます。ドキュメントに複数のオペレーションがある場合は、Operation name(GetCountry)を入力します。

3. 送信してレスポンスを読む

Ctrl/Cmd+Enter を押すか Send をクリックします。GraphQL サーバーはクエリが失敗しても 200 OK を返すことが多いので、ボディを確認しましょう:

  • data には結果が入ります。
  • errors にはメッセージとパスとともに問題が列挙されます。両方を含むレスポンスは、部分的な結果を意味します。

4. 認証と環境を追加する

GraphQL API の認証は REST API と同じです。トークンを環境変数に入れ、Bearer 認証を {{token}} に設定します。環境を切り替えれば、同じクエリをローカルとステージングで実行できます。リクエストをコレクションに保存すれば、クエリがそのままドキュメントになります。

5. クエリを整形し、型を生成する

ツールサイドバーの Backend & API セクションから GraphQL Formatter & Types を開きます:

  • Query: format & request はクエリを整形・圧縮し、オペレーションと変数を一覧表示して、JSON のリクエストボディ、cURL コマンド、fetch の呼び出しを生成します。未定義・未使用のフラグメントや名前のないオペレーションも指摘します。
  • Schema (SDL) → TypeScript はスキーマを TypeScript の型に変換します。オペレーションまで完全に型付けしたい場合は、GraphQL Code Generator がさらに対応します。

知っておきたい制限

  • スキーマエクスプローラーやイントロスペクションによる補完はありません。クエリは自分で書くか、コードベースから貼り付けてください。
  • WebSocket 上の GraphQL サブスクリプションには専用のモードがありません。クライアントの WebSocket ツールは、ポイントで利用する高度な機能です。

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

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

code --install-extension sayaib.hue-console