Trabalhar com o Explorador do Graph

  • Artigo

Graph Explorer é uma ferramenta de desenvolvedor que você pode usar para saber mais sobre APIs do Microsoft Graph. Ele tem uma variedade de recursos para ajudá-lo em sua jornada. Este artigo descreve alguns dos recursos importantes do Graph Explorer e como usá-los.

Para obter uma visão geral, consulte Usar o Explorador do Graph para experimentar as APIs do Microsoft Graph.

Na navegação superior, você pode entrar, exibir o locatário que está usando, acessar suas configurações e encontrar links úteis e um mecanismo de comentários.

Captura de tela do cabeçalho Explorer do Graph

  • Locatário: exiba o locatário que você está usando no momento.
  • Configurações: Acessar o Graph Explorer configurações para alterar o tema da interface ou para obter uma área de areia instantânea gratuita pré-configurada com pacotes de dados de exemplo.
  • Ajuda: acesse links úteis, como a documentação ou o repositório GitHub para o Graph Explorer.
  • Comentários: se você quiser fornecer comentários, poderá preencher o formulário de pesquisa.
  • Avatar de perfil: entre, exiba seu perfil, consenta com permissões, alterne contas ou saia da sua conta. Para obter detalhes sobre como consentir com permissões, consulte Consentimento para permissões.

O usuário ou administrador deve conceder ao Explorador do Graph as permissões corretas utilizando um processo de consentimento para acessar dados no Microsoft Graph. Você pode consentir com permissões no Graph Explorer escolhendo a guia Modificar permissões ou a opção Consentimento para permissões no avatar do perfil quando você estiver conectado.

A opção Consentimento para permissões no avatar de perfil contém a lista de todas as permissões disponíveis:

  1. Clique no avatar do perfil e escolha a opção Consent to permissions . Essa opção contém a lista de todas as permissões disponíveis.
  2. Na lista de todas as permissões, concorde com as que deseja.

Captura de tela do Explorador do Graph com a opção Selecionar permissões realçada

A guia Modificar permissões lista todas as permissões necessárias para executar a consulta na barra de endereços. Quando possível, escolha a permissão menos privilegiada.

Para consentir as permissões:

  1. Selecione uma consulta de exemplo e execute-a.
  2. Selecione a guia Modificar permissões.
  3. Consulte a lista de permissões necessárias para executar a consulta.
  4. Selecione o botão Consentimento ao lado da permissão que você deseja consentir.

Captura de tela do Explorador do Graph com as etapas de consentimento para permissões realçadas

Observação

O recurso Modificar permissões está atualmente em versão prévia e algumas consultas podem estar faltando permissões.

Painel esquerdo

O painel esquerdo permite que você acesse os recursos main do Graph Explorer:

Consultas de exemplo

A guia Consultas de exemplo fornece um conjunto de consultas categorizadas pelo serviço que você pode selecionar e executar para ajudá-lo a começar as chamadas do Microsoft API do Graph.

Captura de tela da guia consultas de exemplo

Quando você seleciona uma consulta, a consulta selecionada preenche a caixa de consulta. Para experimentar a solicitação, escolha Executar consulta.

Recursos

Use a guia Recursos para explorar os recursos do Microsoft Graph nos pontos de extremidade beta e v1.0. Navegue pela lista de recursos ou use a barra de pesquisa para pesquisar um recurso específico.

Captura de tela da guia recursos

Na guia Recursos , você pode exportar uma coleção de recursos para uma coleção do Postman fazendo o seguinte:

  1. No menu kebab ao lado do recurso, selecione Adicionar à coleção.
  2. Quando terminar de adicionar recursos, escolha A coleção Versão prévia.
  3. No modo de exibição da coleção, você pode examinar os recursos selecionados e remover qualquer um, se desejar.
  4. Escolha Baixar coleção Postman.

Captura de tela da tela da coleção de visualização

Histórico

Todas as consultas executadas no Graph Explorer são salvas por 30 dias na guia Histórico. Na guia Histórico, você pode:

  • Exporte todos os itens de histórico no formato .har .
  • Excluir todos os itens do histórico.
  • Visualizar um item do histórico.
  • Executar uma consulta.
  • Exporte um item de histórico no formato .har .
  • Excluir um item do histórico.

Captura de tela da guia Histórico

Para compartilhar as consultas executadas, selecione o botão Compartilhar situado ao lado do botão Executar consulta e selecione Copiar. Isso copia um link compartilhável que permite que outras pessoas vejam sua consulta e os resultados.

Captura de tela do Explorador do Graph com as opções Compartilhar e Copiar realçadas

Área de consulta

Use a área de consulta para executar solicitações e ver as respostas. A área de consulta inclui os seguintes elementos:

  • Métodos HTTP: uma lista suspensa dos métodos HTTP.
  • Versão da API: uma lista suspensa das versões da API disponíveis publicamente.
  • Caixa de consulta: uma barra em que você pode compilar manualmente sua consulta ou ver a consulta autopovoada se você selecionou uma no painel esquerdo.
  • Corpo da solicitação: um espaço para gravar o corpo da solicitação no formato JSON ou conteúdo MIME, de acordo com a solicitação desejada.
  • Cabeçalhos de solicitação: uma seção para adicionar cabeçalhos à sua solicitação especificando a chave e o valor.
  • Modificar permissões: você precisa consentir com as permissões certas para poder executar uma consulta. Para obter detalhes, consulte consentir com permissões.
  • Token de acesso: esta guia mostra seu token de acesso quando você está conectado. Você pode copiar o token se precisar usá-lo em seu aplicativo cliente REST favorito.

Captura de tela do Graph Explorer realçando a área de consulta

Ao executar uma consulta, você verá uma visualização de resposta e cabeçalhos de resposta no painel de resposta.

Além da resposta, este painel também inclui:

Usar o poder das bibliotecas de cliente

Para cada consulta de API REST selecionada ou inserida no Graph Explorer, você pode encontrar como fazer essa chamada em cada um dos idiomas com suporte: C#, Java, JavaScript, Go e PowerShell.

Captura de tela do Explorador do Graph com a guia trechos de código realçada

Integração do Kit de ferramentas do Microsoft Graph

O Microsoft Graph Toolkit é uma coleção de componentes da Web reutilizáveis e agnósticos da estrutura e auxiliares para acessar e trabalhar com o Microsoft Graph. Os componentes são totalmente funcionais, com fornecedores internos que se autenticam e buscam dados do Microsoft Graph.

O graph Explorer permite visualizar componentes do Microsoft Graph Toolkit que correspondem às consultas de API. Um ponto azul na guia componente do kit de ferramentas indica que o Kit de Ferramentas fornece um componente para a consulta REST especificada atualmente no Graph Explorer. Você pode copiar facilmente o código do componente em seu aplicativo.

Captura de tela mostrando a guia Componentes do Kit de Ferramentas

Integração de cartões adaptáveis

Os Cartões adaptáveis são trechos da interface de usuário que não dependem da plataforma, criados em JSON, que os aplicativos e serviços podem dividir. Um ponto azul na guia Cartões Adaptáveis indica que um cartão adaptável está disponível para a consulta selecionada.

Captura de tela da guia cartões adaptáveis no Explorador do Graph com os detalhes da resposta realçados

Próximas etapas