Puntos clave
- 01Formatea consultas, mutaciones, suscripciones y esquemas SDL usando el analizador graphql.js oficial.
- 02Valida la sintaxis e informa la línea y columna exactas de los errores — no se necesita esquema.
- 03Los comentarios GraphQL (#) se eliminan al formatear; usa cadenas de descripción para la documentación que desees conservar.
- 04Se ejecuta completamente en tu navegador — las consultas de API internas y los esquemas propietarios permanecen privados.
¿Por Qué Formatear Documentos GraphQL?
Las consultas GraphQL pueden volverse complejas rápidamente — fragmentos anidados, variables en línea, múltiples definiciones de operación y definiciones de tipo SDL con interfaces y directivas. El formato consistente acelera la revisión entre pares y facilita detectar llaves de cierre faltantes o desajustes de argumentos de un vistazo.
El formateador utiliza el analizador graphql.js de referencia — el mismo analizador que incluye la especificación GraphQL. Esto significa que el formato canónico que obtienes aquí coincide con lo que produce el complemento GraphQL de Prettier y la mayoría de las herramientas GraphQL. Cualquier cosa que se analice correctamente aquí se analizará correctamente en Apollo, Relay y graphql-request.
Cómo Formatear un Documento GraphQL
- 01
Pega tu GraphQL
Pega una consulta, mutación, suscripción, fragmento o definición de esquema SDL en el panel de entrada.
- 02
Haz clic en Formatear
El analizador emite el documento con indentación canónica — indentación de dos espacios, un campo por línea, alineación de argumentos consistente. El resultado aparece en el panel de salida.
- 03
Valida opcionalmente
Haz clic en Validar para confirmar que el documento se analiza sin producir una salida formateada. El resultado es una confirmación o una lista de errores de sintaxis con números de línea y columna.
- 04
Copia el resultado
Haz clic en Copiar para obtener el documento formateado. Pégalo en tu base de código, una descripción de PR o un archivo de documentación.
Seguro para Esquemas Internos y Consultas de API
El analizador graphql.js se ejecuta completamente en tu navegador. Ningún texto de operación o definición de esquema se envía a ningún servidor. Esto lo hace seguro para formatear consultas que hacen referencia a nombres de campo privados o sistemas de tipo internos que no deseas exponer a herramientas de terceros.
La validación aquí es solo sintáctica — la herramienta verifica que el documento sea un documento GraphQL válido, pero no verifica si los nombres de campo existen en un esquema real, si las variables coinciden con tipos de argumentos o si las directivas se aplican correctamente. La validación consciente del esquema requiere que el esquema de destino se cargue junto con el documento.
Preguntas Frecuentes del Formateador GraphQL
¿El formato GraphQL valida contra un esquema?
No — solo validación de sintaxis. Verificar si los campos y argumentos existen requiere el esquema de destino. Esta herramienta confirma que el documento es un documento GraphQL válido, nada más.
¿Se conservarán los comentarios en mi GraphQL?
No. Las líneas que comienzan con # se eliminan del analizador. Usa cadenas de descripción entre comillas triples para la documentación que debe sobrevivir al formato.
¿Qué versión de la especificación GraphQL es compatible?
La especificación de octubre de 2021, incluidos objetos de entrada OneOf y la directiva @specifiedBy.
¿Puedo formatear definiciones de esquema SDL, no solo documentos de operación?
Sí. Las definiciones de tipo, declaraciones de interfaz, tipos de unión, enumeraciones, directivas y descripciones se transfieren correctamente a través del formateador.
¿Se carga la consulta o el esquema en algún lugar?
No. El analizador graphql.js se ejecuta completamente en tu navegador — nada sale de tu dispositivo.