Si encuentras algún detalle que te causa duda puedes dejarlo en la sección de comentarios y te responderemos tan rápido como podamos.
Solución:
Parece que ahora hay https://www.npmjs.com/package/graphql-docs
Explorador de documentación generado dinámicamente para esquemas GraphQL. Su objetivo es proporcionar una mejor visión general de un esquema que GraphiQL, pero sin funciones de consulta.
También puede generar un static archivo de documentación basado en un archivo de esquema o punto final de GraphQL:
npm install -g graphql-docs
graphql-docs-gen http://GRAPHQL_ENDPOINT documentation.html
Que yo sepa, todavía no existe una herramienta que genere automáticamente documentación HTML para una API de GraphQL, pero descubrí que GraphiQL es aún más útil que cualquier documentación de API en HTML que haya visto.
GraphiQL le permite explorar de forma interactiva el esquema de un servidor GraphQL y ejecutar consultas en él al mismo tiempo. Tiene resaltado de sintaxis, autocompletado e incluso le dice cuándo su consulta no es válida sin ejecutarla.
si estas buscando static documentación, me pareció bastante conveniente leer el esquema en lenguaje de esquema GraphQL. Gracias a otra gran característica de GraphQL, la introspección de esquemas, puede imprimir fácilmente el esquema para cualquier servidor al que tenga acceso. Simplemente ejecute la consulta de introspección contra el servidor y luego imprima el esquema de introspección resultante así (usando graphql-js):
var graphql = require('graphql');
var introspectionSchema = ; // paste schema here
console.log(graphql.printSchema(graphql.buildClientSchema(introspectionSchema)));
El resultado será algo como esto:
# An author
type Author
id: ID!
# First and last name of the author
name: String
# The schema's root query type
type Query
# Find an author by name (must match exactly)
author(name: String!): Author
Encontré un generador de páginas estáticas para documentar el esquema GraphQL. Enlace GitHub.
La exportación HTML se ve así.
Ejemplo de documento de GitHub GraphQL
Te mostramos las reseñas y valoraciones de los lectores
Recuerda algo, que tienes permiso de valorar este post si te fue útil.