Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GraphQL Docs Explorer #1616

Merged
merged 5 commits into from Jul 31, 2019

Conversation

@gschier
Copy link
Collaborator

commented Jul 30, 2019

Closes #451

This PR adds the ability to visually browse documentation for GraphQL schemas. The UI/UX is closely inspired by GraphiQL.

Here's what it looks like with the GatsbyJS GraphQL API.

image

image

image

There are three ways to open the documentation for a GraphQL request:

  • Click the new menu item Schema > Show Documentation
  • Cmd-click a type in the query
  • Hover over a type to bring up a doc preview, then click a desired type

image

image

@gschier gschier changed the title Implement a GraphQLExplorer for visually browsing schemas GraphQL Docs Explorer Jul 30, 2019

@gschier gschier merged commit bb5eaaa into develop Jul 31, 2019

4 checks passed

continuous-integration/appveyor/branch AppVeyor build succeeded
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details

@gschier gschier deleted the feature/graphql-docs-explorer branch Jul 31, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant
You can’t perform that action at this time.