Depuração de uma API

Cenário

Depois de criar uma API, depure-a no console do APIG definindo cabeçalhos HTTP e parâmetros de corpo para verificar se a API está sendo executada normalmente.

• As APIs com caminhos de solicitação de back-end contendo variáveis não podem ser depuradas.
• Se uma API tiver sido vinculada a uma política de limitação de solicitações, a política não funcionará durante a depuração da API.

Pré-requisitos

• Você criou um grupo de API e uma API.
• Você configurou o serviço de back-end da API.

Procedimento

1. Acesse o console de gerenciamento.
2. Clique em no canto superior esquerdo e selecione uma região.
3. Clique em no canto superior esquerdo e escolha API Gateway.
4. Escolha um tipo de gateway no painel de navegação.
   • Shared Gateway: você pode criar e gerenciar APIs imediatamente. Você será cobrado com base no número de chamadas de API.
   • Dedicated Gateways: você pode criar e gerenciar APIs depois de comprar um gateway. Você será cobrado com base na duração de uso do gateway.

5. No painel de navegação, escolha API Publishing > APIs.
6. Depure uma API. Você pode usar um dos seguintes métodos:
   • Na coluna Operation da API que você deseja depurar, escolha More > Debug.
   • Clique no nome da API de destino e clique em Debug no canto superior direito da página de detalhes da API exibida.
   Figura 1 Depuração de uma API
   

   No lado esquerdo, defina os parâmetros de solicitação da API listados em Tabela 1. No lado direito, veja as informações de solicitação e resposta da API depois de clicar em Send Request.

   Tabela 1 Parâmetros para depurar uma API

   Parâmetro	Descrição
   Protocol	Esse parâmetro só pode ser modificado se você definir Protocol para HTTP&HTTPS para a API.
   Method	Esse parâmetro só pode ser modificado se você definir Method como ANY para a API.
   Suffix	Você só pode definir um caminho se tiver definido Matching ao Prefix match para a API.
   Path	Caminho de solicitação da API.
   Path Parameters	Esse parâmetro só pode ser modificado se você tiver definido parâmetros de caminho (como {test}) para a API.
   Headers	Cabeçalhos e valores HTTP.
   Query Strings	Consultar parâmetros e valores de cadeia.
   Body	Esse parâmetro só pode ser modificado se você definir Method como PATCH, POST ou PUT para a API.

   

   Os campos exibidos na página de depuração variam de acordo com o tipo de solicitação.

7. Depois de definir os parâmetros da solicitação, clique em Send Request.

   A caixa no canto inferior direito exibe a resposta da solicitação da API.

   • Se a depuração for bem-sucedida, o código de status HTTP 200 e os detalhes da resposta serão exibidos.
   • Se a solicitação não for enviada, um código de status HTTP 4xx ou 5xx será exibido. Para mais detalhes, consulte Códigos de erro.

8. Você pode enviar mais solicitações com diferentes parâmetros e valores para verificar a API.
   

   Para modificar as configurações da API, clique em Edit no canto superior direito e modifique os parâmetros na página Edit API.

Operações de acompanhamento

Depois que a API for depurada com sucesso, publique a API em um ambiente específico para que ela possa ser chamada pelos usuários. Para garantir a segurança da API, crie políticas de limitação de solicitações (consulte Criação de uma política de limitação de solicitações), políticas de controle de acesso (Criação de uma política de controle de acesso) e chaves de assinatura (Criação e uso de uma chave de assinatura) para a API.