O Explorador API é um IDE integrado no navegador para explorar a API GraphQL de um projeto. Permite que os desenvolvedores Archie Core construam e executem consultas GraphQL facilmente a partir do espaço de trabalho.

O Explorador API utiliza os seus dados reais de produção em tempo real.

---

Introspeção

Um esquema GraphQL tem um sistema de introspeção integrado que publica a estrutura do esquema. Isso permite que o Explorador API ofereça recursos poderosos de preenchimento automático ao escrever consultas GraphQL.

Uma vez dentro do bloco items, digite “em”. A partir daqui, é fácil ver e selecionar o campo email das operações disponíveis na API. O preenchimento automático é contextual conforme a sua posição na consulta que está a construir, e filtra as opções com base no que está a ser digitado.

Para ativar manualmente o menu de preenchimento automático e ver as opções disponíveis, pressione a combinação de teclas [Shift] + [Espaço]. Esta ação exibe o menu contextual, permitindo-lhe selecionar o campo desejado, como items, da lista.

Além disso, a introspeção ajuda-nos a detetar erros nas consultas. O sistema reconhece quando os tipos não estão disponíveis ou estão configurados incorretamente — por exemplo, Number deveria ser String, campo não disponível na tabela, bem como validações. Portanto, ao usar o Explorador API, passe o cursor sobre as linhas onduladas vermelhas para ver as sugestões de erro.

Aceder à documentação da API

O Explorador API inclui uma referência de esquema integrada para ajudá-lo a entender o seu modelo de dados ao escrever consultas. Existem duas formas de aceder:

1. O painel de documentação

Clique no botão Documentation (Documentação) localizado na barra de ferramentas superior direita. Isto alterna um painel lateral esquerdo onde pode explorar e pesquisar todas as Queries, Mutations e Types disponíveis.

2. Navegação rápida contextual

Como mostrado na imagem, pode saltar diretamente para a documentação de um campo específico que está a escrever:

• Passe o cursor sobre um nome de campo (por ex. cities) no editor. Aparecerá uma dica mostrando o seu tipo de retorno (por ex. CitiesConnection).
• Clique no nome do tipo dentro da dica.
• O painel lateral de Documentação abrirá automaticamente e navegará diretamente para essa definição de tipo específica, mostrando-lhe todos os subcampos disponíveis (como items, count, aggregates) e as suas descrições.

Composer

O Composer é uma ferramenta visual para construir consultas que normalmente está aberta por defeito no lado esquerdo do Explorador API. Permite-lhe selecionar campos e argumentos para gerar automaticamente sintaxe GraphQL válida.

Se fechou o painel ou não o vê, pode reabri-lo facilmente:

• Procure o botão Composer localizado na barra de ferramentas superior direita.
• Está posicionado diretamente ao lado do botão Documentation (Documentação).
• Ao clicar neste botão alternará o painel lateral do Composer, devolvendo o editor visual à vista.

Experimente abrir cities e marcar a opção count. A seguinte consulta será preenchida na área de texto, que pode ser executada para verificar quantas cidades existem.

query MyQuery {
  cities {
    items {
      nameCity
    }
  }
}