GraphQL Documentation Explorer
Installation and usage
GraphQL-Docs supports both a dynamic mode and a static mode. In dynamic mode, GraphQL-Docs tries to work similarly to GraphiQL. Either use the minified files from GitHub:
<!-- Note that you need to include React and ReactDOM *before* this script tag -->
Or download it into your own package via NPM:
npm install --save graphql-docs
GraphQL-Docs exposes a single React component that requires a function to run a
query against a server and return a
Promise with the result:
Static documentation generation
You can also generate a static documentation file based on a schema file or GraphQL endpoint:
npm install -g graphql-docsgraphql-docs-gen http://GRAPHQL_ENDPOINT documentation.html
- Markdown rendered documentation (using Marked).
- All types and fields are recursively searched from the schema's root query and mutation objects. Types that can't be queried are not included.
- Field arguments listed in separate tables in the cases where they do contain a description.
- Improved layout with some sort of navigation
- On-page search