Using GraphQL Clients

Using GraphQL client IDEs

There are many open-source GraphQL client IDEs you can use to access GitHub's GraphQL API.

See GraphQLでの呼び出しの作成 for extensive information on HTTP methods, authentication, and GraphQL call structure.

First, choose a client. Common options include GraphiQL, Insomnia, and Altair (desktop/web/extension). You can see the full list of clients in the GraphQL organization's tool directory.

The following generic instructions will work with most GraphQL clients:

Point the client at the GraphQL endpoint: https://api.github.com/graphql.
Add an Authorization header: Authorization: Bearer TOKEN (replace TOKEN with your GitHub personal access token. For more information, see 個人用アクセストークンを管理する).
Set the request method to POST or if it's available, use the client-provided GraphQL mode.
Enter your query or mutation in the editor and, if needed, provide variables in the "Variables" panel.

Example:
```
query {
  viewer {
    login
  }
}
```
If your client needs a schema for documentation rendering or autocomplete, fetch it via a GraphQL introspection query. Many clients can do this automatically from the "Docs" panel.

Minimal introspection query:
```
query IntrospectionQuery {
  __schema {
    types {
      name
    }
  }
}
```
Run the request and inspect the JSON response. Query from example should return the login associated with the GitHub personal access token you authenticated with.

Use the client UI to explore docs, run queries, and save requests as needed.

GitHub CLI

You can also use the command line with GitHub CLI to run GraphQL queries.

Install and authenticate with GitHub CLI.
Run a query against https://api.github.com/graphql using the GraphQL endpoint with the gh api subcommand.

Example:

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

This should return the login associated with the GitHub personal access token you authenticated with.

Requesting support

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

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

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

Using GraphQL Clients

この記事の内容

Using GraphQL client IDEs

GitHub CLI

Requesting support