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