Compartilhar via


Importar uma API do GraphQL

APLICA-SE A: todas as camadas do Gerenciamento de API

No Gerenciamento de API, você pode adicionar uma API do GraphQL em um dos dois modelos: passagem para um ponto de extremidade do GraphQL existente ou importação de um esquema do GraphQL e criação de uma API do GraphQL sintético com resolvedores de campo personalizados. Para obter mais informações, confira a Visão geral do GraphQL.

Neste artigo, você vai:

  • Adicionar uma API do GraphQL de passagem à instância do Gerenciamento de API.
  • Testar sua API do GraphQL.

Se você quiser importar um esquema GraphQL e configurar resolvedores de campo usando pontos de extremidade REST ou SOAP API, consulte Importar um esquema GraphQL e configurar os resolvedores de campo.

Pré-requisitos

Adicionar uma API do GraphQL

  1. No portal do Azure, navegue até a instância do Gerenciamento de API.

  2. No menu à esquerda, selecione APIs>+Adicionar API.

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

    Captura de tela da 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 tela dos campos para criar uma API do GraphQL.

    Campo Description
    Nome de exibição O nome pelo qual a API do GraphQL será exibida.
    Nome Nome bruto da API do GraphQL. Preenche automaticamente conforme você digita o nome de exibição.
    Tipo do GraphQL Selecione Passagem do GraphQL para importar de um ponto de extremidade da API do GraphQL existente.
    Ponto de extremidade da API do GraphQL A URL base com o nome do ponto de extremidade da API do GraphQL.
    Por exemplo: https://example.com/your-GraphQL-name. Você também pode usar o ponto de extremidade "swapi" comum do GraphQL, como https://swapi-graphql.azure-api.net/graphql, como demonstração.
    Carregar esquema Opcionalmente, selecione procurar e carregar seu arquivo de esquema para substituir o esquema recuperado do ponto de extremidade GraphQL (se disponível).
    Descrição Adicione uma descrição da sua API.
    Esquema de URL Faça uma seleção com base no ponto de extremidade do GraphQL. Selecione uma das opções que inclui um esquema de WebSocket (WS ou WSS) se a API do GraphQL incluir o tipo de assinatura. Seleção padrão: HTTP(S).
    Sufixo da URL da API Adicione um sufixo de URL para identificar essa API específica nesta instância de Gerenciamento de API. Ele deve ser exclusivo nessa instância do Gerenciamento de API.
    URL base Campo não editável exibindo a URL base da API
    Marcas Associe sua API do GraphQL a marcações novas ou existentes.
    Produtos Associe sua API do GraphQL a um produto para publicá-la.
    Controlar a versão desta API? Selecione para aplicar um esquema de controle de versão à API do GraphQL.
  5. Selecione Criar.

  6. Depois que a API for criada, navegue ou modifique o esquema na guia Design. Captura de tela da exploração do esquema GraphQL no portal.

Testar a API do GraphQL

  1. Navegue até sua instância de Gerenciamento de API.

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

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

  4. Selecione a guia Teste para acessar o console de teste.

  5. Em Cabeçalhos:

    1. Selecione o cabeçalho menu suspenso Nome.
    2. Insira o valor para o campo Valor.
    3. Adicione mais cabeçalhos selecionando + Adicionar cabeçalho.
    4. Exclua os cabeçalhos usando o ícone da lixeira.
  6. Se você adicionou um produto à API do GraphQL, aplique o escopo do produto em Aplicar escopo do produto.

  7. Em Editor de consultas, faça o seguinte:

    1. Selecione pelo menos um campo ou subcampo da lista no menu lateral. Os campos e subcampos selecionados são exibidos no editor de consultas.

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

      Captura de tela demonstrando 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 passar valores diferentes.

  9. Selecione Enviar.

  10. Veja a Resposta.

    Captura de tela da exibição da resposta da consulta de teste.

  11. Repita as etapas anteriores para testar cargas diferentes.

  12. Quando o teste for concluído, saia do console de teste.

Testar uma assinatura

Se a API do GraphQL der suporte a uma assinatura, você poderá testá-la no console de teste.

  1. Verifique se a API permite um esquema de URL do WebSocket (WS ou WSS) apropriado para sua API. Você pode habilitar essa configuração na guia Configurações.

  2. Criar uma solicitação de assinatura no Editor de solicitações e, em seguida, selecionar Conexão para estabelecer uma conexão WebSocket para o serviço back-end.

    Captura de tela de uma consulta de assinatura no editor de consultas.

  3. Examine os detalhes da conexão no painel Assinatura.

    Captura de tela da conexão Websocket no portal.

  4. Os eventos assinados aparecem no painel Assinatura. A conexão WebSocket é mantida até que você a desconecte ou se conecte a uma nova assinatura WebSocket.

    Captura de tela dos eventos de assinatura do GraphQL no portal.

Proteger a API do GraphQL

Proteja sua API GraphQL aplicando as políticas existentes de autenticação e autorização e uma política de validação GraphQL para proteger contra ataques específicos do GraphQL.

Próximas etapas