Partilhar via

API de malha para visualização de esquema GraphQL e explorador de esquema

O esquema GraphQL, baseado na GraphQL Schema Definition Language (SDL), define o formato dos dados expostos na API. Ele fornece flexibilidade aos consumidores enquanto oculta os detalhes da implementação de back-end. O esquema usa uma coleção de tipos de objeto que contêm campos.

Visualização do esquema

Acesse a visualização do esquema selecionando Esquema no canto inferior esquerdo da tela Desenvolvimento de dados. Esta exibição mostra uma versão baseada em texto do GraphQL SDL com tipos, campos e operações gerados.

A imagem a seguir mostra um exemplo da exibição de esquema, incluindo uma lista de objetos disponíveis nesse esquema.

Nota

A exibição de esquema é somente leitura. Modifique objetos somente no explorador de esquema.

Captura de tela da tela de exibição de esquema da API, que inclui o explorador de esquema no painel esquerdo.

Explorador de esquemas

O explorador de esquema está localizado no painel à esquerda e também está disponível quando você usa o editor no modo de exibição de consulta. O explorador permite que os usuários visualizem rapidamente os tipos e campos disponíveis, bem como consultas e mutações, definidas na API.

Todos os tipos de GraphQL disponíveis nos objetos escolhidos quando você se conecta a uma fonte de dados aparecem na lista Explorador de esquemas. Os tipos aparecem sob o nome da fonte de dados da qual foram derivados. A imagem a seguir mostra o tipo SalesOrderDetail derivado da tabela SalesOrderDetail no ponto de extremidade de análise SQL do AdventureWorks .

Captura de tela do painel Explorador de esquema, mostrando a lista expandida de tipos disponíveis em uma fonte de dados de exemplo chamada SalesOrderDetail.

Além dos tipos, a API de malha para GraphQL gera automaticamente consultas e mutações para novos objetos que você escolhe expor.

Em nosso exemplo do AdventureWorks, expandir a lista de consultas mostra as consultas geradas automaticamente para a fonte de dados.

Captura de ecrã do painel Explorador de esquemas, mostrando uma lista expandida de consultas geradas automaticamente.

Expanda o nó de mutações na árvore do explorador de esquema para ver as mutações geradas automaticamente pela API.

Captura de ecrã do painel Explorador de esquemas, mostrando uma lista expandida de mutações geradas automaticamente.

Modificar objetos usando o explorador de esquema

Você pode usar o explorador de esquema para modificar objetos depois que a API os cria para você. No exemplo a seguir, selecionamos as reticências ao lado do tipo SalesOrderDetail derivado de nosso banco de dados AdventureWorks :

Captura de ecrã do explorador de esquemas com as reticências selecionadas, mostrando as opções de menu disponíveis.

As seguintes opções estão disponíveis para Tipos:

  • Esquema de atualização - Permite atualizar o esquema com novos objetos da fonte de dados.

  • Renomear - Altera o nome do objeto. Essa alteração afeta apenas o esquema da API e não afeta o objeto de fonte de dados original do qual ela é derivada.

  • Remover do esquema - Exclui o objeto do esquema GraphQL, para que você não possa mais fazer referência a ele.

  • Gerenciar relacionamentos - Abre a experiência de gerenciamento de relacionamentos. Para obter mais informações, consulte Gerenciar relacionamentos na API de malha para GraphQL.

  • Propriedades - Mostra informações adicionais sobre o objeto.

Ativar e desativar consultas e mutações

O recurso habilitar ou desabilitar consultas e mutações fornece aos administradores e desenvolvedores controle granular sobre o acesso e o uso da API. Ele permite que você ative ou desative seletivamente consultas e mutações específicas dentro do esquema GraphQL. Isso permite gerenciar os recursos da API dinamicamente sem modificar o código ou implantar alterações.

Consultas e mutações no explorador de esquema têm duas outras opções:

  • Desativar: impede que quaisquer solicitações executem a consulta ou mutação. Se a execução for tentada, um erro será retornado. Depois que uma consulta ou mutação é desabilitada, ocorre uma recarga de esquema e a consulta ou mutação aparece acinzentada no explorador de esquema.

Captura de ecrã da opção de desativação de consulta ou mutação apresentada no explorador de esquemas.

  • Ativar: Permite reativar uma consulta ou mutação anteriormente desativada. A consulta ou mutação fica imediatamente disponível após a operação de recarregamento de esquema que ocorre quando você seleciona a opção Ativar .

Captura de tela da opção ativar consulta de mutação mostrada no explorador de esquema.

As consultas ou mutações geradas automaticamente a partir de procedimentos armazenados só podem ser excluídas. Após a exclusão, eles podem ser readicionados usando as opções Obter dados ou Atualizar esquema .

Conteúdos relacionados

  • Last updated on