GraphQL Docs

What GraphQL Docs is

GraphQL Docs is a free, self-hosted web explorer for documenting GraphQL schemas. It focuses on presenting a schema overview rather than providing GraphiQL-style querying. The project supports dynamic documentation and static generation. Its command-line generator creates 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. Described field arguments appear in separate tables, while types that cannot be queried are excluded. A React component is available and requires a fetcher function that queries a server and returns a Promise. Installation is documented through npm, with minified files also available from GitHub releases. CSS is included in the JavaScript for its 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 uses the MIT license.