Importar uma GraphQL API

O GraphQL é uma linguagem de consulta open source e padrão da indústria para APIs. Ao contrário das APIs baseadas em pontos finais (ou estilo REST) concebidas em torno de ações sobre recursos, as APIs do GraphQL suportam um conjunto mais amplo de casos de utilização e focam-se em tipos de dados, esquemas e consultas.

Ao utilizar a Gestão de API para expor as GraphQL APIs, pode:

  • Adicione um ponto final ou esquema de GraphQL como API no portal do Azure, CLI do Azure ou outras ferramentas do Azure.
  • (Pré-visualização) Aumente ou crie uma API do GraphQL com informações de APIs REST ou SOAP, utilizando resoluções DE HTTP para campos definidos num esquema GraphQL.
  • Proteja as APIs do GraphQL ao aplicar políticas de controlo de acesso existentes e uma política de validação do GraphQL para proteger e proteger contra ataques específicos do GraphQL.
  • Explore o esquema e execute consultas de teste relativamente às Graph APIs nos portais do Azure e do programador.

Nota

  • Uma única GraphQL API na Gestão de API pode ser mapeada para um único ponto final de back-end de GraphQL.
  • Uma API do GraphQL requer um esquema GraphQL, seja a partir de um ponto final do GraphQL existente ou carregado por si.
  • A Gestão de API suporta tipos de operação de consulta, mutação e subscrição em esquemas de GraphQL.
  • As subscrições não são suportadas no escalão de serviço Consumo.
  • Uma subscrição tem de ser implementada com o protocolo WebSocket graphql-ws. As consultas e mutações não são suportadas no WebSocket.

Neste artigo, irá:

  • Saiba mais sobre as vantagens da utilização de APIs do GraphQL.
  • Adicione uma API do GraphQL à sua instância de Gestão de API.
  • Teste a API do GraphQL.
  • Conheça as limitações da sua GraphQL API no Gestão de API.

Se quiser importar um esquema do GraphQL e configurar resoluções de campos com pontos finais REST ou SOAP API, veja Importar um esquema do GraphQL e configurar resoluções de campos.

Pré-requisitos

Adicionar uma API do GraphQL

  1. Na portal do Azure, navegue para a sua instância de Gestão de API.

  2. No menu esquerdo, selecione APIs>+ Adicionar API.

  3. Em Definir uma nova API, selecione o ícone do GraphQL .

    Captura de ecrã a mostrar a seleção do ícone do GraphQL na lista de APIs.

  4. Na caixa de diálogo, selecione Completo e preencha os campos de formulário necessários.

    Captura de ecrã dos campos para criar uma GraphQL API.

    Campo Descrição
    Nome a apresentar O nome pelo qual a API do GraphQL será apresentada.
    Nome Nome não processado da API do GraphQL. Preenche automaticamente à medida que escreve o nome a apresentar.
    Ponto final da API do GraphQL O URL base com o nome do ponto final da API do GraphQL.
    Por exemplo: https://example.com/your-GraphQL-name. Também pode utilizar um ponto final comum do GraphQL "Star Wars", como https://swapi-graphql.azure-api.net/graphql uma demonstração.
    Carregar esquema Opcionalmente, selecione para procurar e carregar o ficheiro de esquema para substituir o esquema obtido do ponto final do GraphQL (se disponível).
    Descrição Adicione uma descrição da sua API.
    Esquema do URL Selecione HTTP, HTTPS ou Ambos. Seleção predefinida: Ambas.
    Sufixo do URL da API Adicione um sufixo de URL para identificar esta API específica nesta instância Gestão de API. Tem de ser exclusivo nesta instância Gestão de API.
    URL Base Campo não editável a apresentar o URL base da API
    Etiquetas Associe a API do GraphQL a etiquetas novas ou existentes.
    Produtos Associe a API do GraphQL a um produto para publicá-la.
    Gateways Associe a API do GraphQL a gateways existentes. Seleção de gateway predefinida: Gerida.
    Controlar a versão desta API? Selecione para aplicar um esquema de controlo de versões à API do GraphQL.
  5. Selecione Criar.

  6. Depois de criar a API, procure o esquema no separador Estrutura , na secção Front-end . Captura de ecrã a mostrar a exploração do esquema do GraphQL no portal.

Testar a API do GraphQL

  1. Navegue para a sua instância de Gestão de API.

  2. No menu de navegação lateral, na secção APIs , selecione APIs.

  3. Em Todas as APIs, selecione a sua GraphQL API.

  4. Selecione o separador Teste para aceder à consola de teste.

  5. Em Cabeçalhos:

    1. Selecione o cabeçalho no menu pendente Nome .
    2. Introduza o valor no campo Valor .
    3. Adicione mais cabeçalhos ao selecionar + Adicionar cabeçalho.
    4. Elimine cabeçalhos com o ícone de caixote do lixo.
  6. Se adicionou um produto à API do GraphQL, aplique o âmbito do produto em Aplicar âmbito do produto.

  7. Em Editor de consultas:

    1. Selecione pelo menos um campo ou subcampo na lista no menu lateral. Os campos e subcampos que selecionar aparecem no editor de consultas.

    2. Comece a escrever no editor de consultas para compor uma consulta.

      Captura de ecrã a mostrar a adição de campos ao editor de consultas.

  8. Em Variáveis de consulta, adicione variáveis para reutilizar a mesma consulta ou mutação e transmitir valores diferentes.

  9. Selecione Enviar.

  10. Ver a Resposta.

    Captura de ecrã a mostrar a resposta da consulta de teste.

  11. Repita os passos anteriores para testar payloads diferentes.

  12. Quando o teste estiver concluído, saia da consola de teste.

Nota

Pode testar uma subscrição na consola de teste:

  • Configure uma consulta de subscrição no editor de consultas e, em seguida, selecione Ligar para estabelecer uma ligação WebSocket ao serviço de back-end.
  • Reveja os detalhes da ligação no painel Subscrição .
  • A ligação WebSocket é mantida até a desligar ou ligar a uma nova subscrição do WebSocket.

Passos seguintes