FREEDOM251

Freedom251 › Developer Documentation Software

GraphQL Docs

Free plan Web

Visit GraphQL Docs Alternatives

GraphQL Docs's own site

What GraphQL Docs is

GraphQL Docs is a free, self-hosted web explorer for documenting GraphQL schemas. It focuses on presenting schema structure rather than providing query features. It supports dynamic use and static documentation: a command-line generator can create a static HTML file from a schema file or a GraphQL endpoint. The explorer renders Markdown descriptions and recursively follows types and fields reachable from the root query and mutation objects. Described field arguments appear in separate tables, while types that cannot be queried are excluded. A React component is also available, and it requires a fetcher function that queries a server and returns a Promise. Installation is documented through npm or by using minified files from GitHub releases. The CSS is included in the JavaScript, so no separate dependency is needed for that styling. Package metadata specifies Node.js 4.4.0 or higher and React and ReactDOM peer dependencies at version 15.0.1 or higher within the stated range. The repository identifies its license as MIT and names Magnus Hallin as author. Improved navigation and on-page search are listed as planned features.

Who it suits

GraphQL Docs suits teams that want to explore or publish schema documentation without query functionality. It may fit projects able to meet its listed Node.js and React peer dependency requirements.

What it does well

  • Dynamic and static documentation modes
  • Generates static HTML from a schema or endpoint
  • Renders Markdown descriptions and field arguments
  • CSS is included in the JavaScript

What to know first

  • Does not include querying features
  • Excludes types that cannot be queried
  • Improved navigation and on-page search are planned
  • Requires a fetcher function for the React component

Getting started

  1. Install the package from npm or use minified files from GitHub releases.
  2. For dynamic mode, configure the React component with a fetcher function that queries a server and returns a Promise.
  3. For static output, run the command-line generator with a schema file or GraphQL endpoint.

Verdict

GraphQL Docs centers on schema exploration, with both dynamic use and static HTML generation. Its lack of query features and exclusion of unqueryable types are important scope limits to consider.

Questions

Is GraphQL Docs free?

Yes. It has a free plan.

Does it run GraphQL queries?

No. It focuses on schema documentation and does not include querying features.

Can I generate static documentation?

Yes. Its command-line generator can create a static HTML file from a schema file or GraphQL endpoint.

What platforms are supported?

Web is listed as its platform.

Is GraphQL Docs open source?

The repository identifies its license as MIT.

Who is the maker?

Package metadata names Magnus Hallin as the author.

Facts from GraphQL Docs's own pages

Dependencies
The README says the CSS is included in the JavaScript code, so no other dependencies are required for that styling. · github.com, 4 Oct 2026
Documentation features
The explorer renders Markdown documentation and recursively searches types and fields reachable from the schema’s root query and mutation objects. · github.com, 4 Oct 2026
Field arguments
Field arguments with descriptions are listed in separate tables. · github.com, 9 Oct 2026
Installation
The project can be installed from NPM as graphql-docs. · github.com, 9 Oct 2026
License
The repository identifies its license as MIT. · github.com, 9 Oct 2026
Limit
The project README says GraphQL Docs does not include querying features. · github.com, 9 Oct 2026
Maker
The package metadata names Magnus Hallin as the author. · github.com, 4 Oct 2026
Notable limits
Types that cannot be queried are excluded from the explorer. · github.com, 4 Oct 2026
Operating modes
It supports dynamic and static documentation modes. · github.com, 4 Oct 2026
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. · github.com, 4 Oct 2026
Planned features
Improved navigation and on-page search are listed as planned features. · github.com, 9 Oct 2026
Purpose
GraphQL Docs is a documentation explorer for GraphQL schemas. · github.com, 9 Oct 2026
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. · github.com, 9 Oct 2026
Rendered descriptions
Documentation is rendered as Markdown using Marked. · github.com, 9 Oct 2026
Schema overview
It aims to provide a better overview of a schema than GraphiQL, without GraphiQL’s querying features. · github.com, 9 Oct 2026
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. · github.com, 9 Oct 2026
Scope
The project says it aims to give a better schema overview than GraphiQL, without querying features. · github.com, 4 Oct 2026
Static generation
The command-line generator can create a static HTML documentation file from a schema file or GraphQL endpoint. · github.com, 4 Oct 2026
Static output
The command line generator can create a static HTML documentation file from a schema file or GraphQL endpoint. · github.com, 9 Oct 2026
Usage modes
It supports dynamic and static documentation modes. · github.com, 9 Oct 2026

Where GraphQL Docs stands on Freedom251

Look at these too