GraphQL クライアントの使用

さまざまな GraphQL クライアントとライブラリを使って、実際の GitHub データに対してクエリを実行できます。

この記事の内容

GraphQL クライアント IDE の使用

GitHub の GraphQL API にアクセスするために使用できるオープンソースの GraphQL クライアント IDE は多数あります。

HTTP メソッド、認証、GraphQL 呼び出し構造の詳細については、「GraphQLでの呼び出しの作成」を参照してください。

まず、クライアントを選びます。 一般的な選択肢として、GraphiQL、Insomnia、Altair (デスクトップ/Web/拡張機能) などがあります。 詳細なクライアント一覧については、GraphQL organization のツール ディレクトリに関するページを参照してください。

次の汎用的な手順は、ほとんどの GraphQL クライアントで利用できます。

  1. クライアントの接続先として GraphQL エンドポイント https://api.github.com/graphql を指定します。

  2. Authorization ヘッダー Authorization: Bearer TOKEN を追加します (TOKEN を GitHub personal access token に置き換えてください)。 詳細については、「個人用アクセス トークンを管理する」を参照してください。

  3. 要求メソッドを POST に設定するか、利用できる場合はクライアントが提供する GraphQL モードを使います。

  4. エディターにクエリまたはミューテーションを入力し、必要に応じて [Variables] パネルに変数を指定します。

    例:

    query { viewer { login } }

  5. クライアントでドキュメントのレンダリングやオートコンプリートを行うためにスキーマが必要な場合は、GraphQL イントロスペクション クエリを介してフェッチします。 多くのクライアントは、[Docs] パネルからこれを自動的に実行できます。

    最小限のイントロスペクション クエリ:

    query IntrospectionQuery { __schema { types { name } } }

  6. 要求を実行し、JSON 応答を確認します。 例のクエリを実行すると、認証に使った GitHub personal access token に関連付けられたログインが返されるはずです。

このクライアント UI を使って、必要に応じてドキュメントの確認、クエリの実行、要求の保存を行います。

GitHub CLI

GitHub CLI を使うと、コマンド ラインから GraphQL クエリを実行することもできます。

  1. GitHub CLI をインストールし、認証を行います。
  2. gh api サブコマンドを使い、GraphQL エンドポイントで https://api.github.com/graphql に対してクエリを実行します。

例:

gh api graphql -f query='query { viewer { login } }'

その結果、認証に使った GitHub personal access token に関連付けられたログインが返されるはずです。

サポートのリクエスト

GitHub Apps、OAuth apps、API 開発に関する疑問、バグ レポート、ディスカッションについては、GitHub のコミュニティ ディスカッションの API と Webhook カテゴリ を調べてください。 ディスカッションは、GitHub スタッフによって管理および維持され、GitHub コミュニティによって回答されます。

次の場合は、お問い合わせフォームを使用して GitHub サポートに直接連絡することを検討してください。

  • GitHub のスタッフからの確実なレスポンス
  • 機密データや個人的な心配に関連するサポート リクエスト
  • 機能に関する要求
  • GitHub の製品に関するフィードバック