Why you need static documentation for your GraphQL API

This page summarizes the projects mentioned and recommended in the original post on dev.to

Our great sponsors
  • Appwrite - The Open Source Firebase alternative introduces iOS support
  • SonarLint - Clean code begins in your IDE with SonarLint
  • Scout APM - Less time debugging, more time building
  • graphiql

    GraphiQL & the GraphQL LSP Reference Ecosystem for building browser & IDE tools.

    By dynamic documentation, I mean a documentation that interacts with your API directly. GraphiQL is probably the most popular tool out-there to do this.

  • swagger-ui

    Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

    If you used REST before, there are many great tools that can do this, like Swagger, which generates a schema (swagger.json) out of your endpoints. This schema can then be used to generate dynamic or static documentation.

  • Appwrite

    Appwrite - The Open Source Firebase alternative introduces iOS support . Appwrite is an open source backend server that helps you build native iOS applications much faster with realtime APIs for authentication, databases, files storage, cloud functions and much more!

  • magidoc

    Fast and highly customizable static documentation generator for GraphQL APIs.

    Given the circumstances, I personally took the initiative to create on a new tool: A tool that would allow for extensive customization, while also being simple. That's how Magidoc was born. With this project, I aim to provide various templates and starters that are easily customizable.

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts