[HN Gopher] Show HN: SpectaQL - auto-generate GraphQL API docume... ___________________________________________________________________ Show HN: SpectaQL - auto-generate GraphQL API documentation Author : mrbogle Score : 18 points Date : 2021-03-18 20:47 UTC (2 hours ago) (HTM) web link (github.com) (TXT) w3m dump (github.com) | mrbogle wrote: | Hey all, we couldn't find exactly what we wanted in a | documentation generator, so we wrote our own. Let us know if you | have any questions! | hirundo wrote: | 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 searchable hosted white label version. | mrbogle wrote: | Thanks for the feedback! Yeah I can see how it could get out | of hand with that many types and mutations. The single page | situation would probably break down in that scenario too. | We'll think about how it might be able to scale. Feel free to | open an issue on the repo and we can work it out together. | hirundo wrote: | What I'd really like to see is a dynamic diagram of the | schema, such that when you click on a type it becomes the | center of a graph of associations. Then click to view the | text docs. The diagram could be a menu / entry point for | the text docs. A kind of map to the N-dimensional space. | mrbogle wrote: | Ah that would definitely be interesting, you could break | out queries / mutations where it is an input, output, or | related types where it is a resolver type | newhouse wrote: | Thanks for the kind words! I wrote most of the enhancements | and thought the static and dynamic example support was | crucial to have. | | Our schema is not as big as yours, but I could see how things | could get a bit unwieldy on the navbar. Come on over to the | repo and we can work on a solution together - I'm sure | there's something we can figure out if we put on our design + | product + engineer hats. ___________________________________________________________________ (page generated 2021-03-18 23:00 UTC)