gqldoc
A command-line tool written in Go that generates API documentation from GraphQL schemas or endpoints.
What is gqldoc?
gqldoc is a command-line tool that generates API documentation from GraphQL schemas or endpoints. It automates the creation of documentation by introspecting GraphQL schemas, either from local files or live endpoints, and outputs structured documentation files. This solves the problem of manually maintaining API docs for GraphQL services.
GraphQL API developers and teams who need to generate and maintain up-to-date documentation for their GraphQL schemas, especially those working with multiple schema files or automated CI/CD pipelines.
Developers choose gqldoc for its simplicity, direct integration with GraphQL introspection, and automation capabilities via GitHub Actions, reducing manual documentation overhead and ensuring docs stay synchronized with schema changes.
Overview
The easiest way to make API documents for GraphQL
Use Cases
Best For
- Generating documentation from live GraphQL endpoints with authentication headers
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
