Document a GraphQL API

graphql graphql-js
Francisco Canela picture Francisco Canela · Sep 15, 2016 · Viewed 31.2k times · Source

With REST we can use Swagger, RAML or other technologies to document our API and generate an HTML documentation that our consumers can read without any need of interaction with the servers.

Does something similar exist for GraphQL? Is there any way to generate a documentation of resources and properties?

Answer

jun picture jun · Oct 31, 2016

It looks like there is now https://www.npmjs.com/package/graphql-docs

Dynamically generated documentation explorer for GraphQL schemas. It aims to provide a better overview of a schema than GraphiQL, but without querying features.

enter image description here

You can also generate a static documentation file based on a schema file or GraphQL endpoint:

npm install -g graphql-docs
graphql-docs-gen http://GRAPHQL_ENDPOINT documentation.html

Related questions

GraphQL Expected Iterable, but did not find one for field xxx.yyy

I'm currently trying GraphQL with NodeJS and I don't know, why this error occurs with the following query: { library{ name, user { name email } } } I am not sure if the type of my resolveLibrary is right, because at any example I …

Read More
How to query list of objects with array as an argument in GraphQL

I'm trying to query a list of objects having array of IDs. Something similar to following SQL query: SELECT name FROM events WHERE id IN(1,2,3,...); How do I achieve this in GraphQL?

Read More
Firebase & GraphQL

Does anyone have any experience with GraphQL and Firebase? I figure one would place the firebase calls in the resolver of the relevant field, passing some variable from the props of the component into the arguments of the query. How …

Read More