Skip to the content
Know your tech before you buy it. Makers: get listed from $49/mo

GraphQL Docs

github.com

  • Free plan
  • Web
7.1 Club score Visit github.com

What GraphQL Docs is

GraphQL Docs is a free, self-hosted web explorer for understanding GraphQL schemas. It emphasizes schema documentation rather than GraphiQL-style querying and works in dynamic or static modes. Its command-line generator can produce a static HTML documentation file from a schema file or GraphQL endpoint. The explorer renders Markdown descriptions and recursively follows types and fields reachable from the schema’s root query and mutation objects. Field arguments that include descriptions appear in separate tables, while types that cannot be queried are omitted. A React component is also provided; it requires a fetcher function that queries a server and returns a Promise. Installation is documented through npm, with minified files available from GitHub releases. Styling CSS is bundled in the JavaScript, so no separate styling dependency is required. Package metadata names Magnus Hallin as author and specifies Node.js 4.4.0 or later, with React and ReactDOM peer dependencies at version 15.0.1 or later within the stated range. The repository uses the MIT license.

Who it suits

It suits developers who need a browsable GraphQL schema reference or static HTML documentation. Teams wanting built-in query execution should note that querying is outside its scope.

Good to know, and what to watch

  • Dynamic and static documentation modes
  • Generates static HTML from schemas or endpoints
  • Renders Markdown descriptions and field arguments
  • React component supports custom fetchers
  • MIT-licensed and self-hosted
  • No GraphQL querying features
  • Unqueryable types are excluded
  • Requires Node.js 4.4.0 or later
  • Improved navigation and search are planned

The verdict

GraphQL Docs provides a focused, self-hosted schema reference with dynamic exploration and static generation. It works well for documentation, but users needing query execution must use another tool.

What the maker publishes

Dependencies
The README says the CSS is included in the JavaScript code, so no other dependencies are required for that styling. source
Documentation features
The explorer renders Markdown documentation and recursively searches types and fields reachable from the schema’s root query and mutation objects. source
Field arguments
Field arguments with descriptions are listed in separate tables. source
Field arguments
Field arguments with descriptions are listed in separate tables. source
Installation
The README documents installation from npm and use of minified files from GitHub releases. source
Installation
The project can be installed from NPM as graphql-docs. source
License
The repository identifies its license as MIT. source
Limit
The project README says GraphQL Docs does not include querying features. source
Maker
The package metadata names Magnus Hallin as the author. source
Notable limits
Types that cannot be queried are excluded from the explorer. source
Operating modes
It supports dynamic and static documentation modes. source
Package compatibility
The package metadata specifies Node.js version 4.4.0 or higher and React and ReactDOM peer dependencies at version 15.0.1 or higher within the stated range. source
Planned features
The README lists improved navigation and on-page search as planned features. source
Planned features
Improved navigation and on-page search are listed as planned features. source
Purpose
GraphQL-Docs is a dynamically generated documentation explorer for GraphQL schemas. source
Purpose
GraphQL Docs is a documentation explorer for GraphQL schemas. source
React component
The package exposes a React component that requires a fetcher function to run a query against a server and return a Promise. source
React component
In dynamic mode, it exposes a React component that requires a function to run a query against a server and return a Promise. source
Rendered descriptions
Documentation is rendered as Markdown using Marked. source
Schema overview
It aims to provide a better overview of a schema than GraphiQL, without GraphiQL’s querying features. source
Schema traversal
It recursively searches types and fields reachable from the schema’s root query and mutation objects, excluding types that can’t be queried. source
Scope
The project says it aims to give a better schema overview than GraphiQL, without querying features. source
Static generation
The command-line generator can create a static HTML documentation file from a schema file or GraphQL endpoint. source
Static output
The command line generator can create a static HTML documentation file from a schema file or GraphQL endpoint. source

Checked against the maker's pages on 9 Oct 2026.