Teste APIs GraphQL com o GraphQL Explorer

Consulte suas APIs GraphQL usando uma ferramenta de teste GraphQL integrada.

Antes de Iniciar

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

A ativação de consultas introspectivas permite que o Explorador 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ções. 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 ServiceNow AI Platform. Para obter informações adicionais sobre a interface, consulte GraphiQL readme No GraphiQL GitHub repositório.

Procedimento

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

   Inclua os namespaces da aplicação e do esquema na consulta. Para obter informações sobre diretivas que você pode aplicar, consulte 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 Adiar para transmitir resultados para o campo openedBy após a resposta inicial ao incidente.

   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 Executar consulta ( ).
   Dica:

   Você também pode usar um atalho de teclado. Para ver a lista de atalhos de teclado disponíveis, selecione o ícone Abrir caixa de diálogo de teclas curtas ( ).
   O resultado da consulta retorna no painel direito.
6. Opcional: Selecione o ícone Adicionar guia ( ) para executar consultas adicionais.

O que Fazer Depois

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

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