API de malha para visualização de esquema GraphQL e explorador de esquema
O esquema GraphQL, que é baseado no GraphQL Schema Definition Language (SDL), define o formato dos dados expostos na API. É uma camada de abstração que fornece flexibilidade aos consumidores enquanto oculta os detalhes da implementação de back-end. O esquema é baseado em uma coleção de tipos de objeto que contêm campos.
Visualização do esquema
Você pode acessar a visualização do esquema selecionando Esquema no canto inferior esquerdo da tela Desenvolvimento de Dados. A exibição mostra uma versão baseada em texto do GraphQL SDL com tipos, campos e operações gerados.
A imagem a seguir é um exemplo da exibição de esquema, incluindo uma extensa lista de objetos disponíveis nesse esquema.
Nota
A exibição de esquema é somente leitura. Você só pode modificar objetos no explorador de esquema.
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 que estão 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. Na imagem a seguir, você vê o tipo SalesOrderDetail derivado da tabela SalesOrderDetail no ponto de extremidade de análise SQL da AdventureWorks .
Além dos tipos, a API de malha para GraphQL gera automaticamente consultas e mutações para quaisquer novos objetos que você escolher expor.
Em nosso exemplo do AdventureWorks, expandir a lista de consultas mostra as consultas geradas automaticamente para a fonte de dados.
Para ver as mutações geradas automaticamente pela API, expanda o nó de mutações na árvore do explorador de esquemas.
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 :
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. OBSERVAÇÃO: Essa alteração afeta apenas o esquema da API e não tem efeito sobre o objeto de fonte de dados original do qual ela foi derivada.
- Remover do esquema - Efetivamente exclui o objeto do esquema GraphQL para que você não possa mais fazer referência a ele.
- Gerenciar relacionamentos - Leva você à 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/desabilitar para 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.
As consultas e mutações no explorador de esquemas têm duas opções adicionais:
- Desativar - Impede que quaisquer solicitações executem a consulta ou mutação. Se a execução for tentada, um erro será retornado. Quando uma consulta ou mutação é desabilitada, ocorre uma recarga de esquema e a consulta ou mutação aparece acinzentada no explorador de esquema.
- Ativar - Reative uma consulta ou mutação anteriormente desativada. A execução do item fica imediatamente disponível após a operação de recarga do esquema que ocorre após a seleção da opção Ativar .
Observe que consultas ou mutações geradas automaticamente a partir de procedimentos armazenados só podem ser excluídas. Uma vez excluídos, eles podem ser adicionados novamente usando as opções Obter dados ou Atualizar esquema .