spectaql
dociql
Our great sponsors
spectaql | dociql | |
---|---|---|
14 | 4 | |
1,046 | 353 | |
2.5% | 1.1% | |
6.8 | 0.0 | |
6 days ago | about 1 month ago | |
JavaScript | JavaScript | |
MIT License | Apache License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
spectaql
-
What software do you use to write documentation?
I've also used spectaql before to auto generate graphql docs.
-
Best tool for creating GraphQL API documentation?
Other than that, SpectaQL is also a good tool that is well maintained.
-
Open Source Static Documentation Generator for GraphQL
Hi All, Wanted to share that we officially released v1.0 of SpectaQL
-
Introducing SpectaQL 1.0 - an even better way to autogenerate GraphQL API documentation
It gets downloaded thousands of times per week on NPM
Last year, Anvil introduced SpectaQL to the opensource community, and it's been a big success. We've seen thousands of weekly downloads and a healthy amount of user support and interest via GitHub.
-
Manipulate and query GraphQL Schemas with ease using Microfiber
A while back we introduced SpectaQL to the open source community and it's been a big success. It gets thousands of weekly downloads, has a healthy amount of user support and interest via github, and has had a number of articles written about it like this one and this one. Our goal for SpectaQL has always been to be the de-facto go-to library to use for auto-generating static HTML documentation for any GraphQL API. A very important feature of SpectaQL is its ability to "hide" any parts of your API that you don't want to expose in your documentation. This sounds like a simple task, but in practice it's actually a bit tricky. In order to make interacting and manipulating a GraphQL schema easy, we developed a tool designed specifically for this purpose. Eventually we realized that while this tool was super integral to SpectaQL, it would also be useful for other applications so we decided to break it out into its own library and open source it! In this post, I'll introduce Microfiber and give an overview of its most interesting features and capabilities.
-
Creating Static Documentation For GraphQL APIs Using GraphQL SDL
For this, we'll be using a library called SpectaQL, which is based on the popular library Spectacle that works with Open API and Swagger specifications. SpectaQL can be installed globally on your machine from npm:
-
Keeping certain parts of your GraphQL schema hidden from Introspection
GraphQL is a popular and powerful way to build your APIs and power your website; we use it for most of our APIs at Anvil. One of the best things about GraphQL is that it provides an Introspection Query capability which allows users to explore and learn about what's possible in a given API. In that way, GraphQL is "self-documenting". Some great tools like Playground and Anvil's own SpectaQL leverage the Introspection Query.
-
SpectaQL - generate static docs for a GraphQL schema
Source: github.com/anvilco/spectaql
-
Good Graphql Documentation
I haven't tried it myself, but I recently heard about SpectaQL and it seems worth a look.
dociql
- Open Source: Generate GraphQL API documentation in minutes yet beautiful
-
magidoc alternatives - dociql and graphdoc
3 projects | 4 Aug 2022
Magidoc is a GraphQL documentation generator
-
Introducing SpectaQL 1.0 - an even better way to autogenerate GraphQL API documentation
SpectaQL was originally forked from a project called DociQL to add some enhancements there. And DociQL was originally forked from a project called Spectacle to make it work with GraphQL. And (finally) Spectacle was designed to work with Swagger/OpenAPI. Swagger/OpenAPI is a specification designed to help standardize the description of REST APIs with many routes, and uses JSON Schema as the way to define Data Types/Models. This means that SpectaQL had to wrestle with several layers of history and transformations; making SpectaQL's enhancements fit into the DociQL world, which in turn had to make things fit into the Spectacle/Swagger/OpenAPI world.
-
Autogenerate GraphQL API documentation with SpectaQL
There was one solution we found that was the closest to what we were looking for: DociQL. It's an open-source, node.js project that describes itself like this: "DociQL generates beautiful static HTML5 documentation from a GraphQL endpoint using the introspection query." Awesome!
What are some alternatives?
graphql-playground - 🎮 GraphQL IDE for better development workflows (GraphQL Subscriptions, interactive docs & collaboration)
graphiql - GraphiQL & the GraphQL LSP Reference Ecosystem for building browser & IDE tools.
artwork - GraphQL Foundation artwork
graphdoc - Static page generator for documenting GraphQL Schema
spectacle - Beautiful static documentation generator for OpenAPI/Swagger 2.0
artwork - Contains the collaborative work of the openSUSE marketing and artwork teams. Content is licensed under CC-BY-SA 3.0 (Creative Commons Attribution-ShareAlike 3.0 Unported License).
Docusaurus - Easy to maintain open source documentation websites.
graphql-introspection-tools - A library to query and manipulate GraphQL Introspection Query results in some useful ways.