#562 · Desarrollo y configuración

Formateador de consultas GraphQL

Ordena consultas, mutaciones, fragmentos y selecciones GraphQL para que la jerarquía de campos resulte fácil de revisar. La herramienta separa llaves, argumentos y bloques con una sangría uniforme y conserva cadenas citadas. Es útil para limpiar operaciones copiadas desde logs, documentación o código generado antes de compartirlas o depurarlas, sin ejecutar peticiones ni enviar el contenido a una API.

Entrada de texto

Documento GraphQL
Espacio publicitario

Cómo usar esta herramienta de texto

  1. Introduce una operación o fragmento GraphQL.
  2. Selecciona 2 o 4 espacios de sangría.
  3. Ejecuta el formateo y revisa la estructura de llaves.
  4. Copia o descarga el documento limpio.

Qué hace esta herramienta

Presenta operaciones GraphQL con una jerarquía visual coherente. No comprueba el documento contra un esquema ni realiza llamadas de red.

Recorre el documento carácter a carácter, protege cadenas y comentarios, y genera saltos alrededor de llaves mientras conserva argumentos y directivas en su bloque correspondiente.

La herramienta prioriza legibilidad. Para validación semántica contra un esquema utiliza un validador GraphQL dedicado.

Ejemplo

Entrada: query{usuario{id nombre}}

Salida: cada nivel de selección queda en una línea con sangría proporcional a sus llaves.

Casos de uso

  • Preparar consultas para documentación de APIs.
  • Limpiar operaciones copiadas de herramientas de red.
  • Revisar rápidamente selecciones anidadas.
  • Homogeneizar ejemplos GraphQL de un equipo.

Consejos para obtener mejores resultados

  • Conserva comentarios si contienen contexto útil.
  • Usa 2 espacios para documentos largos con mucha profundidad.
  • Valida variables y tipos contra el esquema después de formatear.
  • Evita pegar respuestas JSON: esta herramienta está pensada para documentos GraphQL.

Detalles del procesamiento

El algoritmo trabaja localmente y distingue cadenas citadas para no interpretar llaves o comas dentro de valores de texto.

No implementa toda la gramática GraphQL como un parser formal y no detecta incompatibilidades con un esquema remoto.

Preguntas frecuentes

¿Este formateador GraphQL valida campos y argumentos contra mi esquema?

No. Da formato al documento, pero no conoce el esquema de tu API y por tanto no puede confirmar si un campo, argumento o tipo existe.

¿Puedo usarlo con queries, mutations, subscriptions y fragments?

Sí. El formateo se basa en la estructura de bloques y funciona con los tipos de operación y fragmentos habituales de GraphQL.

¿Se conservan las variables como $id y las directivas @include?

Sí, se mantienen como texto dentro de la operación. La herramienta reorganiza principalmente espacios, saltos de línea y llaves.

¿Qué sangría es mejor para una consulta GraphQL muy anidada?

Dos espacios suelen reducir el ancho en documentos profundos; cuatro espacios pueden resultar más cómodos para ejemplos cortos o documentación.

¿La consulta GraphQL se envía a un servidor para formatearla?

No. El procesamiento se realiza en el navegador y la herramienta no ejecuta la operación ni necesita una URL de API.

Resumen técnico

MóduloFunción
EntradaDocumento GraphQL
ProcesamientoRecorre el documento carácter a carácter, protege cadenas y comentarios, y genera saltos alrededor de llaves mientras conserva argumentos y directivas en su bloque correspondiente.
PrivacidadProcesamiento local en el navegador
ExportaciónTXT y, cuando corresponde, CSV/JSON