GraphQLクライアント

GraphQLと対話するための最も人気のあるクライアントのいくつかをまとめた概要です。

GraphiQL

GraphiQL は、GraphQLクエリを実行するためのIDE の代名詞的存在です。GraphQLと同時にリリースされたこのツールは、GraphQLサーバーに対してクエリを実行するクライアントと、スキーマドキュメントを閲覧するエクスプローラーを一か所に統合することで、既存のAPIよりも優れた開発体験をGraphQLが提供できることを即座に示しました。

GraphiQL

GraphiQL は特に以下の機能を提供しています：

タブ
カスタムヘッダー
シンタックスハイライト
フィールド、引数、型などのインテリジェントな入力補完
クエリと変数に対するリアルタイムのエラーハイライトとレポート
クエリと変数の自動補完
必須フィールドのクエリへの自動追加
マークダウン対応のドキュメントエクスプローラーと検索
ローカルストレージを使用したクエリ履歴
テーマ

graphql.org/swapi-graphql でデモを利用できます。エディターを使ってGraphQLクエリを作成し、2つのペインの中央にある「Execute Query」ボタンを押すと、クエリへの応答を確認できます。

Voyager

GraphQL Voyager は、インタラクティブなスキーマビジュアライザーの代名詞的存在であり、そのドキュメントで述べているように「GraphQLの背後にあるグラフ」を可視化します。

Voyager

以下の機能を備えています：

グラフ上のクイックナビゲーション。
各タイプの詳細情報を提供する左側パネル。
Relayのラッパークラスを削除してグラフを簡略化する「Skip Relay」オプション。
グラフのルートとして任意のタイプを選択する機能。

ivangoncharov.github.io/graphql-voyager でライブデモを利用できます。

DociQL

DociQL は、GraphQLエンドポイントから美しい静的HTML5ドキュメントを生成するコマンドを提供します。コマンドを実行すると、HTML、CSS、JSファイルを含むディレクトリが生成されます。これらをWebサーバーにコピーすることで、GraphQLスキーマのドキュメントを表示できます。

生成されるドキュメントは、デフォルトで3カラムの単一ページレイアウトを表示し、左カラムにすべてのタイプへのリンク、中央に説明、右にサンプルクエリが表示されます：

DociQL

以下の機能を備えています：

introspectionクエリを使用してGraphQLのスキーマを取得し、ドキュメントをオンザフライで生成します。
「Try it now」リンク付きのリクエストとレスポンスのサンプルを生成します。
ユーザーがユースケースを定義し、ドメイン別にグループ化できます。
HandlebarsテンプレートとSCSSスタイルで設定可能です。
API説明内でのマークダウン対応。
すべてのデバイスと画面サイズで動作するレスポンシブHTML5・CSS3レイアウト。
既存のWebサイトに埋め込み可能な部分的なドキュメント。

生成されたドキュメントのデモが wayfair.github.io/dociql で利用できます。

SpectaQL はDociQLをベースに構築され、GraphQL向けにより適切に適応させたものです。GraphQLに関連する情報のみを表示するテーマを提供し、Swagger/OpenAPIドメインのコンテンツを除去します（たとえば、クエリ例に表示される「Response Content-Types: application/json」や「Response Example (200 OK)」のメッセージを省きます）。

SpectaQL

SpectaQL はいくつかのオプションを使用してGraphQLスキーマのソースを入力することもできます：

introspectionクエリを使用してライブエンドポイントから取得する方法。
introspectionクエリの結果を含むファイルから取得する方法。
SDLのスキーマ定義を含むファイル、複数ファイル、またはglobから取得する方法。

生成されたドキュメントのデモが useanvil.com/docs/api/graphql/reference にあります。

Postman

Postman はAPIの構築と使用のためのAPIプラットフォームです。GraphQL専用に構築されたものではありませんが、PostmanはGraphQLクエリの実行やGraphQL APIの作成における共同作業の効率化に使用できます。

Postman

PostmanはAPIのライフサイクルを加速するツールを含んでおり、APIの設計、テスト、ドキュメント作成、モッキングなどを網羅しています。また、ワークスペースを通じてAPIを整理し、世界中に散らばるチームメンバーと協力することができます。

Altair

Altair は、PostmanのようなGraphQL Client IDEのもう一つの選択肢であり、GraphQL専用です。

Altair

あらゆるGraphQL Client IDEが提供する機能に加えて、Altairは環境（ローカル、ステージング、本番環境のAPIを切り替えられる）とクエリコレクション（チームメンバーと簡単に共有できる）も提供しています。