A Node.js library that autogenerates static, customizable documentation for GraphQL APIs from live endpoints, SDL files, or introspection results.
SpectaQL is a Node.js library that automatically generates static documentation for GraphQL APIs. It pulls schema information from live endpoints, SDL files, or introspection results to create complete, up-to-date documentation with a modern, customizable interface. It solves the problem of manually writing and maintaining GraphQL API docs.
GraphQL API developers and teams who need to generate and maintain documentation for their GraphQL schemas, especially those looking for automated, customizable solutions.
Developers choose SpectaQL for its flexibility in sourcing schema data, extensive customization via themes and metadata, and its ability to keep documentation synchronized with the API without manual updates, all while producing professional-looking output.
Autogenerate static GraphQL API documentation
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Supports ingestion from live GraphQL endpoints, introspection JSON files, and SDL files or globs, allowing teams to generate docs from various schema representations without manual updates.
Offers a theme system for CSS, JS, and HTML customization, including embeddable mode for site integration, enabling branding and layout control as detailed in the themes README.
Allows adding examples, hiding elements, and enhancing docs through metadata injection or a custom @spectaql directive, providing rich content flexibility without code changes.
Includes a development mode with live preview for real-time editing and viewing, speeding up the documentation workflow and reducing iteration time.
Requires a detailed config.yml file and understanding of YAML options, which can be overwhelming for users expecting out-of-the-box simplicity, as noted in the extensive configuration examples.
Needs Node.js installation and global or local setup, adding overhead for teams not already in the Node ecosystem and complicating deployment in non-Node environments.
Admits to beta features like data arrangement plugins and has breaking changes (e.g., version 1.0 migration), indicating potential bugs and instability for production use.