dociql
stepzen-spectaql-docs
dociql | stepzen-spectaql-docs | |
---|---|---|
4 | 3 | |
353 | 1 | |
0.8% | - | |
0.0 | 0.0 | |
about 1 month ago | over 2 years ago | |
JavaScript | HTML | |
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.
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!
stepzen-spectaql-docs
-
Introducing SpectaQL 1.0 - an even better way to autogenerate GraphQL API documentation
There have been several articles written about it, like this one and this one
-
Translate JSON to GraphQL SDL in a Few Clicks
If you want to add documentation to your SDL after this step, StepZen can help you do that in a low-code way as well.
-
Creating Static Documentation For GraphQL APIs Using GraphQL SDL
What comes next? So far, you've learned how to create static documentation based on a GraphQL API locally, but the next step would be to integrate this into your CI/CD and deploy this documentation on a server. Combining with your CI/CD can be done by adding the command to run SpectaQL to your deployment steps. At the same time, StepZen can be integrated with Netlify to deploy the static documentation. You can find the repository with the complete source code for this post here.
What are some alternatives?
spectaql - Autogenerate static GraphQL API documentation
graphql-playground - 🎮 GraphQL IDE for better development workflows (GraphQL Subscriptions, interactive docs & collaboration)
graphql-introspection-tools - A library to query and manipulate GraphQL Introspection Query results in some useful ways.
graphiql - GraphiQL & the GraphQL LSP Reference Ecosystem for building browser & IDE tools.
spectacle - Beautiful static documentation generator for OpenAPI/Swagger 2.0
artwork - GraphQL Foundation artwork
semver - Semantic Versioning Specification
awesome-webpack - A curated list of awesome Webpack resources, libraries and tools
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).
smart-contract-best-practices - A guide to smart contract security best practices