Documentos GraphQL

Formateador GraphQLrevisa qué se ha validado

Trabaja con operaciones, SDL o variables JSON. Añade un esquema SDL completo para comprobar los campos de una operación.

Formateador GraphQL

Entrada

Resultado

Los documentos se procesan en este navegador, sin peticiones API, historial guardado ni entradas en las URL.

Opciones

Sin esquema: solo sintaxis. Con SDL completo: comprobación estática de campos y tipos. Las variables se revisan como objeto JSON; no se verifica el tipo de sus valores.

Documento y esquema: 100.000 caracteres cada uno; variables: 20.000. GraphQL: 20.000 tokens, 100 niveles de anidación; se detiene a los 8 segundos.

Introduce un documento o carga un ejemplo.

El Formateador GraphQL ayuda a revisar consultas copiadas de un registro. Presenta las selecciones anidadas y los fragmentos sin sobrescribir la entrada, para que puedas comparar el resultado con el documento original.

Una consulta legible puede pedir un campo que no existe. El estado distingue la comprobación de sintaxis de la validación estática con el esquema aportado; no implica que una petición al servidor vaya a funcionar.

Por qué usar este Formateador GraphQL

Conservar las definiciones juntas

El Formateador GraphQL usa dos espacios de sangría y muestra el documento completo. En la estructura aparecen operaciones, variables y fragmentos con su línea de origen. Las referencias no se expanden ni se completan con definiciones inventadas.

Un documento compacto se transforma en líneas con sangría junto a una tarjeta independiente de variables.

Contrastar los campos con el contrato

Un validador GraphQL necesita el esquema de la API para detectar campos desconocidos. Con un SDL completo puedes revisar selecciones, argumentos y relaciones entre fragmentos, y localizar qué entrada necesita una corrección.

Una consulta supera la revisión de sintaxis; al añadir el esquema, se resalta un campo incompatible.

Decide el alcance de la revisión

01

Elige el tipo de contenido

Operaciones admite consultas, mutaciones, suscripciones y fragmentos. Usa SDL para un type o extend aislado, sin exigir una raíz Query. El modo Variables permite ordenar un objeto JSON sin escribir una consulta.

02

Añade el contexto en sus pestañas

Documento, Esquema y Variables conservan sus textos al cambiar de pestaña. El ejemplo incluye las tres entradas. Antes de aplicarlo verás los nuevos contenidos y la cantidad de caracteres; Deshacer recupera también el resultado anterior.

03

Espera a un resultado actualizado

El modo automático procesa tras una pausa de 400 ms. Desactívalo para usar el botón o Ctrl/Cmd+Intro. Editar una entrada bloquea la exportación hasta completar el proceso; cambiar de vista utiliza el mismo cálculo.

Varias formas de revisar el documento

Formato legible y texto compacto

La sangría facilita la revisión. Al minificar GraphQL se eliminan separadores innecesarios, conservando los espacios obligatorios entre nombres, los valores de cadenas y el orden de los campos. No se optimiza ni reescribe la operación.

Estructura con líneas de origen

La lista muestra operaciones, declaraciones de variables, fragmentos, campos y tipos SDL en tandas de 100. La descarga de estructura incluye la lista completa en JSON, aunque algunas filas sigan ocultas. Su tamaño no mide el coste de ejecución.

Variables sin redondeo

Los números 9007199254740993 y 1.2300e+40 conservan su representación. Las claves mantienen el orden, incluso si parecen números. Una clave duplicada produce un error en lugar de descartar uno de sus valores.

Errores que llevan a la entrada

Cuando el analizador dispone de ubicación, muestra línea y columna. Pulsa un error para abrir la pestaña correspondiente. Si falla el esquema pero la sintaxis es correcta, el texto formateado sigue visible para corregirlo, con las exportaciones desactivadas.

Límites y significado del resultado

Validación estática, sin ejecución
La herramienta no ejecuta resolutores ni predice respuestas. No comprueba valores obligatorios, conversiones en ejecución, escalares personalizados ni reglas de negocio de las variables. Sus tipos declarados en el documento sí participan en las reglas estáticas.
El esquema opcional debe ser SDL completo
No se importan respuestas JSON de introspección ni URL. Incluye la raíz de consulta, los tipos referenciados y las directivas propias. La composición Federation y la generación de código quedan fuera del alcance. El modo SDL independiente solo revisa sintaxis.
Comentarios y descripciones son distintos
Las salidas formateada y minificada eliminan comentarios #. Las descripciones SDL en cadenas se conservan como parte de la sintaxis. La entrada original permanece intacta, sin reparación automática, ordenación de campos ni búsqueda de fragmentos externos.
Los límites detienen el trabajo
Documento y esquema admiten 100.000 caracteres cada uno; variables, 20.000. GraphQL permite 20.000 tokens y 100 niveles de delimitadores; JSON también limita la profundidad a 100. El worker se detiene tras 8 segundos. Divide el documento y vuelve a intentarlo.

Preguntas sobre el Formateador GraphQL

¿Cómo compruebo la sintaxis GraphQL del texto de un editor?

Un analizador puede comprobar la gramática sin conocer el esquema. En Operaciones, deja el esquema vacío para verificar solo sintaxis. Esto no demuestra que el servidor tenga los campos solicitados.

¿Cómo valido operaciones GraphQL con el esquema del servidor?

Pega el SDL completo del servidor en Esquema y la operación con sus fragmentos en Documento. Las reglas estáticas comprueban campos, argumentos y tipos declarados. No prueban autenticación, ejecución ni comportamiento de resolutores.

¿Por qué mis variables GraphQL aparecen como JSON no válido?

Las variables usan JSON estricto, no la notación de objetos de GraphQL ni diccionarios de otro lenguaje. Usa comillas dobles en claves y cadenas, elimina comas finales y coloca un objeto en la raíz. También se rechazan claves duplicadas.

¿Por qué aparece el error «Query root type must be provided»?

El esquema proporcionado como completo no tiene una raíz de consulta válida. Define type Query o señala un tipo objeto existente en una declaración schema. Si solo quieres dar formato a un tipo o extensión aislados, utiliza SDL.

¿Por qué falta la definición del fragmento al imprimir una consulta GraphQL?

Imprimir un nodo de operación no añade definiciones situadas en otro lugar. Aquí se imprime todo el documento pegado. Incluye los fragmentos necesarios en el mismo texto; la herramienta no lee otros archivos ni desarrolla las referencias.

¿Un documento da un resultado inesperado?

Prepara la próxima revisión

Usa el Formateador GraphQL, confirma el alcance indicado en el estado y exporta la vista actual cuando esté lista.