CARACTERÍSTICAS

Documentación autogenerada

Utilice GraphQL Editor para generar una documentación sencilla para su esquema. Utilice nuestra interfaz para crear en línea una documentación completa con soporte para el marcado.

01Generado por programa

GraphQL Editor genera automáticamente la documentación básica de su esquema, todo lo que tiene que hacer es rellenar las descripciones.

documentos generados automáticamente

02Fácil de navegar

Escriba documentos con nuestra interfaz de fácil manejo. Haga clic en un tipo dentro del índice para desplazarse hasta él en el esquema, haga clic en un tipo en el esquema para navegar hasta su documentación o simplemente utilice la barra de búsqueda de la parte superior.

interfaz amigable

03Soporte completo de markdown

Utilice markdown para añadir cabeceras, enlaces, tablas o bloques de código a su documentación. Estilice sus documentos para hacerlos más legibles y atractivos.

rebajasapoyo
play button

Video tutorial

Descubra lo fácil que es crear documentación markdown para su proyecto dentro del Editor GraphQl.

Crear documentos para su esquema  | Tutorial del Editor GraphQL

Documentación de la API GraphQL

Escribir la documentación es un poco complicado y a la mayoría de los programadores no les gusta hacerlo, por lo que seguro que apreciarán una herramienta que les ofrezca mucha ayuda al respecto. GraphQL Editor genera automáticamente la documentación básica, a partir de ahí es tan sencillo como escribir las descripciones. Un gran esquema sin documentación será un gran problema y significará una tonelada de trabajo más adelante. En su lugar, rellénalo sobre la marcha utilizando nuestras intuitivas herramientas de navegación y dale estilo utilizando markdown. Una buena documentación de la API GraphQL es el camino más fácil para atraer a los usuarios

LeftCircle
Documentación Markdown

Lea sobre esta característica en nuestros Docs

Ver docs