Habilitar o botão Experimente para um endpoint REST do produto do API Gateway em seu portal
Use o botão Experimente para permitir que um consumidor de API invoque o endpoint do seu produto por meio do seu portal. Quando um consumidor de API usa o botão Experimente, ele insere os parâmetros de solicitação do método e invoca o endpoint do produto. Depois, o API Gateway invoca sua API pela Internet pública e exibe a resposta na janela Experimente. Você pode usar uma página de produto personalizada para fornecer informações adicionais sobre os parâmetros necessários para acessar sua API.
O API Gateway utiliza os seguintes limites para proteger suas APIs:
O API Gateway permite apenas três solicitações por segundo para sua API.
-
O API Gateway utiliza um tempo limite integrado de 29 mil ms. Sua API real pode ter um limite de tempo maior, mas o API Gateway não aplica esse tempo limite quando um cliente utiliza o botão Experimente.
-
O API Gateway limita a carga útil de resposta a 6 MB.
Considerações
As seguintes considerações podem afetar a maneira como você realiza um teste:
-
O botão Experimente não é aceito quando você visualiza um portal.
-
O botão Experimente não é aceito por APIs REST com os seguintes recursos:
APIs privadas
APIs que usam TLS mútuo.
APIs que usam certificados SSL privados ou autoassinados.
Como proprietário do portal, você é responsável por se comunicar com seus consumidores de API. Esse é o motivo pelo qual o botão Experimente não existe para nenhuma API REST que não seja aceita. O API Gateway não explica isso para você.
Habilitar o botão Experimente para um endpoint REST do produto
O procedimento a seguir mostra como ativar o botão Experimente para um endpoint do produto.
Para saber como utilizar o botão Experimente em um portal, consulte Usar um portal do API Gateway.
Habilitar o botão Experimente para um endpoint REST do produto
No painel de navegação principal, selecione Produtos do portal.
Escolha um produto.
Na guia Documentação, em Páginas de referência de API, escolha o nome de um endpoint REST do produto, como /dogs - GET.
Selecione Editar página.
Para permitir que os clientes invoquem sua API no portal, selecione Recurso Experimente.
Escolha Salvar alterações.
Você precisa publicar novamente todos os portais que usem o produto em questão para as alterações serem implementadas.
