Skip to main content

​
Agrega un esquema de GraphQL

Para crear páginas para tu API de GraphQL, necesitas un esquema de GraphQL válido en formato SDL (Schema Definition Language). Almacena el esquema en tu repositorio de documentación o alójalo en una URL HTTPS que Mintlify pueda obtener.
schema.graphql

​
Generar automáticamente páginas de GraphQL

Para generar automáticamente páginas para cada consulta, mutación y tipo de tu esquema, agrega una propiedad graphql a una pestaña en tu docs.json. Mintlify analiza el esquema y crea una página para cada operación y tipo con nombre.
La propiedad graphql acepta ya sea una cadena (una ruta local o una URL HTTPS) o un objeto con los siguientes campos:
​
string
requerido
Una ruta local a un archivo SDL en tu repositorio de documentación o una URL HTTPS a un archivo SDL alojado. No se aceptan URL HTTP.
​
string
El directorio donde se colocan las páginas generadas. El valor predeterminado es graphql-reference.
Las fuentes de GraphQL solo se admiten en pestañas. Una pestaña que declara graphql no puede declarar también openapi o asyncapi.

​
Páginas generadas

Mintlify organiza las páginas generadas en tres secciones dentro de la pestaña que configuraste:
  • Queries — una página por cada campo de tu tipo raíz Query.
  • Mutations — una página por cada campo de tu tipo raíz Mutation.
  • Types — una página por cada tipo con nombre: object, input, enum, interface, union o scalar.
Cada página de operación muestra la descripción del campo, los argumentos, el tipo de retorno y enlaces a cualquier tipo referenciado. Las páginas de consultas y mutaciones también incluyen una operación de ejemplo generada, las variables requeridas y una respuesta JSON de muestra en el panel lateral (o en línea en dispositivos móviles). Las páginas de tipos renderizan la definición del esquema en modo solo lectura, con los tipos de campo enlazados para que las personas que leen puedan navegar por el grafo.

​
Deprecaciones

Los campos y argumentos marcados con @deprecated en tu esquema se señalan como obsoletos en las páginas generadas. El motivo de la deprecación, cuando se proporciona, aparece junto al campo.

​
Actualiza tu documentación

Mintlify regenera las páginas de referencia de GraphQL cuando ejecutas mint dev o cuando envías cambios a tu repositorio de documentación. Si tu esquema está alojado en una URL HTTPS, las actualizaciones del esquema se incorporan en la siguiente compilación.