Skip to main content

Using GraphQL Clients

You can run queries on real GitHub data using various GraphQL clients and libraries.

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:

  1. Point the client at the GraphQL endpoint: https://api.github.com/graphql.

  2. Add an Authorization header: Authorization: Bearer TOKEN (replace TOKEN with your GitHub personal access token. For more information, see 개인용 액세스 토큰 관리).

  3. Set the request method to POST or if it's available, use the client-provided GraphQL mode.

  4. Enter your query or mutation in the editor and, if needed, provide variables in the "Variables" panel.

    Example:

    query {
      viewer {
        login
      }
    }
    
  5. 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
        }
      }
    }
    
  6. 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.

  1. Install and authenticate with GitHub CLI.
  2. 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 및 웹후크 범주을 탐색합니다. 토론은 GitHub 직원이 검토하고 관리하며 GitHub 커뮤니티에서 답변합니다.

연락처 양식을 사용하여 GitHub 지원에 직접 연락하는 것이 좋습니다.

  • GitHub 직원의 보장된 응답
  • 중요한 데이터 또는 개인 문제와 관련된 지원 요청
  • 기능 요청
  • GitHub 제품에 대한 피드백