stepzen-spectaql-docs
Create static documentation for your GraphQL with StepZen and SpectaQL! (by stepzen-dev)
spectaql
Autogenerate static GraphQL API documentation (by anvilco)
stepzen-spectaql-docs | spectaql | |
---|---|---|
3 | 14 | |
1 | 1,046 | |
- | 1.3% | |
0.0 | 6.8 | |
over 2 years ago | 10 days ago | |
HTML | JavaScript | |
- | MIT License |
The number of mentions indicates the total number of mentions that we've tracked plus the number of user suggested alternatives.
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.
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.
stepzen-spectaql-docs
Posts with mentions or reviews of stepzen-spectaql-docs.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2022-05-03.
-
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.
spectaql
Posts with mentions or reviews of spectaql.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2023-04-27.
-
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.
What are some alternatives?
When comparing stepzen-spectaql-docs and spectaql you can also consider the following projects:
dociql - A beautiful static documentation generator for GraphQL