Testar APIs da GraphQL com o Explorador da GraphQL

Teste a consulta de suas APIs GraphQL usando uma ferramenta de teste GraphQL integrada.

Antes de Iniciar

Crie um esquema para sua GraphQL API. Para obter mais informações, consulte Criar um esquema GraphQL.

A habilitação de consultas introspectivas permite que o Explorador do GraphQL mostre os esquemas na instância no Explorador de documentação e como sugestões de preenchimento automático, o que facilita a localização de consultas e mutação. Para obter mais informações, consulte Habilitar consultas introspectivas para esquemas GraphQL.

Nota:

Não use consultas introspectivas em um ambiente de produção.

Função necessária: graphql_schema_admin ou admin

Por Que e Quando Desempenhar Esta Tarefa

O GraphQL Explorer integra o GraphiQL IDE ao Now Platform. Para obter informações adicionais sobre a interface, consulte o leia- me GraphiQL no repositório GraphiQL GitHub.

Procedimento

1. Navegar até Todos > Serviços web do sistema > GraphQL > Explorador do GraphQL.
2. Opcional: Se você habilitou a introspecção, na barra lateral esquerda, selecione o ícone Mostrar explorador de documentação (ícone ) para exibir e pesquisar consultas ou mutação disponíveis.
3. No editor, insira uma consulta ao esquema.

   Inclua os namespaces da aplicação e do esquema na consulta. Para obter informações sobre as diretivas que você pode aplicar, consulte Diretivas e funções globais.

   Este exemplo mostra o uso dos namespaces da aplicação e do esquema:

   • Namespace da aplicação: x_graph_scope
   • Namespace do esquema: planeta

   query {
     x_graph_scope {
       planet {
         findAll {
           name
           mass
           distance
         }
       }
     }
   }

   Este exemplo mostra o uso da diretiva @defer para transmitir resultados para o campo openedBy após a resposta do incidente inicial.

   query findIncidents {
     now {
       incident {
         findAll {
           description {
             displayValue
           }
           ...
           @defer(label: "my-label", if: true) {
             openedBy {
               firstName
               lastName
             }
           }
         }
       }
     }
   }

4. Opcional: Na parte inferior do editor, selecione Variáveis e insira as variáveis necessárias.
5. Selecione o ícone ).
   Dica:

   Você também pode usar um atalho do teclado. Para ver a lista de atalhos de teclado disponíveis, selecione o ícone ).
   O resultado da sua consulta é retornado no painel direito.
6. Opcional: Selecione o ícone Adicionar guia ( ícone ) para executar consultas adicionais.

O que Fazer Depois

Se você precisar exibir uma lista de consultas anteriores, na barra lateral esquerda, selecione o ícone ).

Para acessar dados de registro em um componente, você pode criar um componente personalizado e consultar seu esquema GraphQL com script a partir do componente. Para obter mais informações, consulte Consultar um esquema GraphQL de um componente.