VS Code で GraphQL API をテストする方法
このページの内容 6 セクション
要点:GraphQL のリクエストは、クエリ、変数、そして必要に応じてオペレーション名を含む JSON ボディを持った HTTP の POST です。GraphQL を理解する REST クライアントなら送信できます。このガイドでは DevSnip Pro の無料の REST API クライアントを使います。クエリ、変数、オペレーション名をそれぞれ入力できる GraphQL モードがあります。
- コマンドパレット(Ctrl/Cmd+Shift+P)から DevSnip Pro: REST API Client を実行します。
- プロトコルを HTTP から GraphQL に切り替えます(リクエスト名の横)。Body タブが Query タブに置き換わります。
- メソッドを POST にし、エンドポイントを入力します。たとえば
https:/(公開のデモ API)や/ countries. trevorblades. com/ {{baseUrl}}/です。graphql
メソッドが GET の場合、クライアントはクエリが送信されないことを警告し、Use POST を提案します。
Query フィールドに:
query GetCountry($code: ID!) {
country(code: $code) {
name
capital
currency
}
}Variables (JSON) に:
{ "code": "DE" }変数フィールドは入力中にチェックされるので、無効な JSON は送信前に指摘されます。ドキュメントに複数のオペレーションがある場合は、Operation name(GetCountry)を入力します。
Ctrl/Cmd+Enter を押すか Send をクリックします。GraphQL サーバーはクエリが失敗しても 200 OK を返すことが多いので、ボディを確認しましょう:
dataには結果が入ります。errorsにはメッセージとパスとともに問題が列挙されます。両方を含むレスポンスは、部分的な結果を意味します。
GraphQL API の認証は REST API と同じです。トークンを環境変数に入れ、Bearer 認証を {{token}} に設定します。環境を切り替えれば、同じクエリをローカルとステージングで実行できます。リクエストをコレクションに保存すれば、クエリがそのままドキュメントになります。
ツールサイドバーの Backend & API セクションから GraphQL Formatter & Types を開きます:
- Query: format & request はクエリを整形・圧縮し、オペレーションと変数を一覧表示して、JSON のリクエストボディ、cURL コマンド、
fetchの呼び出しを生成します。未定義・未使用のフラグメントや名前のないオペレーションも指摘します。 - Schema (SDL) → TypeScript はスキーマを TypeScript の型に変換します。オペレーションまで完全に型付けしたい場合は、GraphQL Code Generator がさらに対応します。
- スキーマエクスプローラーやイントロスペクションによる補完はありません。クエリは自分で書くか、コードベースから貼り付けてください。
- WebSocket 上の GraphQL サブスクリプションには専用のモードがありません。クライアントの WebSocket ツールは、ポイントで利用する高度な機能です。