Live data from Hacker News

Show HN: SpectaQL – auto-generate GraphQL API documentation

github.com

11–14 of 14 posts

Re: Show HN: SpectaQL – auto-generate GraphQL API documentation

#11

I've been using DociQL in an automated pipeline and its been handy! Should be easy to give this a go at some point in the near future. I made a similar change for the introspection url being set dynamically on main line dociql, so good to see it there as well.

Thanks for the comment! We added a lot of things that came to mind while trying to get our docs dialed in ourselves. Glad to see that others were looking for these same enhancements!

Re: Show HN: SpectaQL – auto-generate GraphQL API documentation

#12

I've been using DociQL in an automated pipeline and its been handy! Should be easy to give this a go at some point in the near future. I made a similar change for the introspection url being set dynamically on main line dociql, so good to see it there as well.

We added a number of things that came to mind while trying to get our docs dialed in ourselves. Glad to see that others were looking for these same enhancements! Let us know if you run into any issues

Re: Show HN: SpectaQL – auto-generate GraphQL API documentation

#13
post #9

Amazing, our free trial of GraphQL Editor that we used only for its documentation generator ended, so this is literal a time/money saver. Thank you! EDIT: Have you thought about accepting Github sponsorships[1]? [1] - https://github.com/sponsors

That's great to hear it'll be useful!

Thanks for the heads up on sponsorships, we hadn't thought about accepting them. Currently the project is effectively funded by us at useanvil.com, but we'll talk about opening that up!

Re: Show HN: SpectaQL – auto-generate GraphQL API documentation

#14
post #3

Earlier quoted context omitted.

I appreciate the integrated examples. I wish I had your example generator before I rolled my own. The documention generator we currently use isn't scaling well with 100+ types and 800+ mutations. It makes the sidebar too unwieldy. It looks like SpectaQL has the same issue. Not sure there's a great solution while keeping to static pages. Thanks much for the open license. I hope to try it soon. We might pay for a searc…

We quickly ran into the same issue at Shopify. We've since moved from a flat list into sections by "domains"; within each section is the breakdown by type. You can see it here: https://shopify.dev/docs/admin-api/graphql/reference Of course this grouping has to be done a little manually. And it's not perfect, but definitely better than the flat alternative. For reference, we have thousands of types.

I could see us adding support for grouping via the "metadata" that would inform the nav bar on how to group and accordion / collapse things. There already is a pattern for grouping in the library that is exemplified in the Query and Mutation carats
Post reply on HN