Partilhar via

API de malha para editor GraphQL

A API de malha para GraphQL fornece um ambiente de desenvolvimento gráfico no navegador GraphQL, que permite um playground interativo para compor, testar e ver os resultados ao vivo de suas consultas e mutações do GraphQL.

Para ir para o editor, abra o item API para GraphQL em seu espaço de trabalho no Fabric e selecione Consulta no canto inferior esquerdo da tela do portal.

Captura de tela mostrando onde a opção Consulta aparece no canto inferior esquerdo da tela Malha.

Digite e execute consultas GraphQL diretamente na guia Consulta . Os recursos do Intellisense estão disponíveis com um atalho de teclado: CTRL + Space (Windows) ou Command + Space (macOS). Selecione Executar para executar a consulta e recuperar dados da fonte de dados.

Captura de tela da tela do editor de API, que mostra uma guia Consulta dividida em painéis Executar, Variáveis de consulta e Resultados.

Gerar código

Depois de testar e prototipar a operação desejada do GraphQL, o editor de API gera código Python clichê ou Node.js com base na consulta ou mutação executada no editor. Você pode executar o código gerado localmente para fins de teste e reutilizar partes dele no processo de desenvolvimento de aplicativos.

Important

O código gerado usa credenciais interativas do navegador e deve ser usado apenas para fins de teste. Na produção, sempre cadastre um aplicativo no Microsoft Entra e utilize os escopos e escopos apropriados client_id . Você pode encontrar um exemplo de ponta a ponta com código de exemplo em Connect Applications.

Para começar, execute uma consulta, selecione o botão Gerar código e escolha o idioma de acordo:

Captura de tela da tela do editor de API mostrando a opção como gerar código.

Em seguida, você pode copiar o código gerado e salvá-lo como um arquivo em uma pasta local. Dependendo do idioma escolhido, siga estas etapas simples para testar localmente:

Python

  1. Crie um ambiente virtual executando o comando python -m venv .venv.

  2. Ative o venv executando .venv\Scripts\activate ou source .venv/bin/activate.

  3. Instale a dependência necessária executando pip install azure.identityo .

  4. Execute o código com python <filename.py>.

Node.JS

  1. Na mesma pasta do arquivo que você salvou, crie um package.json arquivo com o seguinte conteúdo:

    {
  "type": "module",
  "dependencies": {}
}

  2. Execute npm install --save @azure/identity ou um comando semelhante no gerenciador de pacotes escolhido para instalar a versão mais recente da biblioteca de identidades.

  3. Execute o código com node <filename>.js.

Desenvolvimento de consultas e mutações

Analise este pequeno esquema do GraphQL. Ele define um único Post tipo com consultas para ler uma única postagem ou listar todas as postagens e mutações para criar, atualizar ou excluir postagens, suportando todos os casos de uso CRUDL (criar, ler, atualizar, excluir, listar).

{
  type Post {
    id: ID!
    published: Boolean
  }

  type Query {
    getPost(id: ID!): Post
    getAllPosts: [Post]
  }

  type Mutation {
    createPost(title: String!, content: String!, author: String!): Post
    updatePost(id: ID!, title: String, content: String, author: String, published: Boolean): Post
    deletePost(id: ID!): Boolean
  }
}

Leia os dados expostos via GraphQL usando qualquer consulta definida no esquema. A getPost consulta se parece com este exemplo.

query MyQuery {
  getPost(id: "1234") {
    title
    content
    author
  }
}

Response:

{
  "data": {
    "getPost": {
      "title": "First Post",
      "content": "This is my first post.",
      "author": "Jane Doe"
    }
  }
}

Use mutações como createPost para escrever dados e criar um post com os parâmetros necessários.

mutation MyMutation {
  createPost(title: "Second post", content: "This is my second post", author: "Jane Doe", published: false) {
    id
    title
    content
    author
  }
}

Response:

{
  "data": {
    "createPost": {
      "id": "5678",
      "title": "Second Post",
      "content": "This is my second post.",
      "author": "Jane Doe"
    }
  }
}

Variáveis de consulta

Use o painel Variáveis de consulta no lado direito da guia Consulta para passar parâmetros como variáveis para suas consultas ou mutações. As variáveis funcionam como variáveis em outras linguagens de programação. Cada variável é declarada com um nome usado para acessar o valor armazenado nela. Usando o exemplo de mutação anterior, modifique-o ligeiramente para usar variáveis de consulta.

mutation MyMutation ($title: String!, $content: String!, $author: String!){
  createPost(title: $title, content: $content, author: $author) {
    id
    title
    content
    author
  }
}

Defina variáveis no painel usando o exemplo a seguir.

{
  "id": "5678",
  "title": "Second Post",
  "content": "This is my second post.",
  "author": "Jane Doe"
}

As variáveis tornam o código de mutação mais limpo, mais fácil de ler, testar e modificar.

Conteúdo relacionado

  • Last updated on