SpectaQL
Autogenerate static GraphQL API documentation
Start new thread
Ben Ogle

SpectaQL - Auto-generate documentation for your GraphQL API

by
Anvil
•
SpectaQL is an open-source static documentation generator for your GraphQL API. Give SpectaQL your GraphQL endpoint or schema file and it will generate HTML and CSS for a static, single-page site. Designed to be themeable and extremely customizable.

Add a comment

Replies

Best
newhouse
Maker
Hey Product Hunt! I'm Chris, the creator of SpectaQL. SpectaQL is an open-source static documentation generator for your GraphQL API. Give SpectaQL your GraphQL endpoint or schema file and it will generate HTML and CSS for a static, single-page site. A major goal for the project is giving you configurability and customization. SpectaQL supports theming and template overriding (see this blog post for details). You can go as deep as you like: override a single style rule, inject your own JavaScript and CSS, or totally replace all the templates with your own. We originally created SpectaQL to scratch our own itch at Anvil. Our website needed reference docs for our own GraphQL API, but we couldn't find any open-source projects that fit the bill. We'd love to get your feedback, and happy to answer any questions!
Derek Foster
This looks great! Can I use this for a ruby GraphQL API?
Ben Ogle
Maker
@fostimus Thanks! Yes you can! SpectaQL just runs from node.js. It can consume a schema from an API written in any language.
Patrick Daniels
Nice work!! Looks awesome!
Ben Ogle
Maker
@patrick_daniels2 Thanks Patrick!
Winggo Tse
Looks cool. Excited to check this out myself!
Ben Ogle
Maker
@winggo Thanks! Let us know if you have any questions!
Allan Almazan
Nice! Can't wait to try the new theming feature.
Ben Ogle
Maker
@allan_almazan2 Thanks! Let us know if you have any feedback!
Jessica Yen
So cool!
Ben Ogle
Maker
@jessica_yen Thanks Jessica!
Carrie Curtin
Dark mode 🔥
Ben Ogle
Maker
Leilanni Makoske
Looks great!
Ben Ogle
Maker
@leilanni_makoske Thanks Leilanni!