Using GraphQL Explorer
In this section, we are going to introduce you to a tool that enables you to experiment with GraphQL quickly and easily.
Running Your First GraphQL Query
- Navigate to the GraphQL explorer.
-
Once the page has loaded, click the “Sign in with GitHub” button. If you don’t have a GitHub account, here are some instructions for getting an account setup.
On your first log in, The GraphQL interface displays a sample query in the left pane that should look like this:
# Type queries into this side of the screen, and you will # see intelligent typeaheads aware of the current GraphQL type schema, # live syntax, and validation errors highlighted within the text. # We'll get you started with a simple query showing your username! query { viewer { login } }
-
Click the “Execute Query” button (it looks like a Play button) to run the query that is in the left pane and display the results in the right pane.
Clicking “Execute Query” should present something that looks like this:
{ "data": { "viewer": { "login": "githubteacher" } } }
The response from a query in GraphQL will be JSON, just like the query itself, and is returned in the exact same format as the request.
-
Make changes to the sample query.
In this case, we only asked GraphQL to tell us our login name, but what if we wanted to know more?
Just below
login
, add a new line with the textavatarUrl
. Now your query should look like this:{ viewer { login avatarUrl } }
To learn more about the information you can request and what is being returned, check out “Tell me why” below .
Tell me why
What Can I Access with the API?
GitHub has made much of the data about a user accessible via the API. To learn more about the data available to the User object, you can check out the user reference documents on developer.github.com.
What Should I See?
When you ran the query above, it should have returned something that looks like this:
{
"data": {
"viewer": {
"login": "githubteacher",
"avatarUrl": "https://avatars3.githubusercontent.com/u/2132216?v=3"
}
}
}