Empezando
EmpezandoIntroducción al cliente Voyager

Introducción al cliente Voyager

Gato GraphQL proporciona el cliente GraphQL Voyager para visualizar el esquema GraphQL de forma interactiva. Accede a él haciendo clic en "Interactive Schema" en el menú del plugin:

Cliente GraphQL Voyager

Voyager ofrece una vista panorámica del esquema GraphQL:

Visualizando el esquema para consultar datos

Hace que sea sencillo entender cómo todos los elementos del esquema se relacionan entre sí, usando flechas para mostrar las conexiones entre tipos:

Elementos del esquema

El esquema tiene un punto de partida, es decir, un tipo desde el que se calculan todas las relaciones. Por defecto, este es la raíz de consultas (en este caso, gestionada vía el tipo QueryRoot), que se indica en el panel flotante en la parte inferior. Para visualizar el esquema referente a mutaciones, podemos seleccionar el tipo raíz de mutación correspondiente (en este caso, MutationRoot):

Tipos GraphQL, en el panel flotante

Cambiando vista desde otro tipo GraphQL

Cambiado a la vista desde la raíz de mutaciones

Al hacer clic en un tipo del esquema se resaltarán sus conexiones, y se mostrarán los metadatos de sus campos (lo mismo ocurre al hacer clic en el nombre del tipo en el panel del lado izquierdo):

Resaltando tipo

El campo de búsqueda en el panel del lado izquierdo permite filtrar los elementos del esquema:

Filtrando elementos del esquema

Al hacer clic en una conexión se resaltará, tanto en el esquema como en el panel del lado izquierdo:

Resaltando conexión

Podemos usar el ratón (y, en cierta medida, los botones en la parte inferior derecha de la pantalla) para navegar por el grafo, acercando y alejando, moviéndonos en cualquier dirección y enfocándonos en elementos:

Navegando el grafo

En el panel flotante en la parte inferior, tenemos algunas opciones adicionales:

  • "Sort by alphabet" ordena alfabéticamente todos los campos en cada tipo
  • "Skip Relay" elimina las clases envoltorio de Relay
  • "Skip deprecated" oculta todos los campos obsoletos
  • "Show leaf fields" muestra todos los campos que no son una conexión

Opciones adicionales