Usar um portal do API Gateway
Depois de publicar seu portal, ele estará disponível na web. Para utilizar seu portal, copie o nome de domínio padrão do portal ou o nome do domínio e insira-o em um navegador. Se o seu portal utilizar um nome de domínio, o nome de domínio padrão não poderá ser utilizado para acessar o portal.
Usar um portal
O procedimento a seguir mostra como acessar um portal e utilizar o botão Experimente relativo a um endpoint REST do produto.
Como usar um portal
Inicie uma sessão no console do API Gateway em https://console.aws.amazon.com/apigateway
. No painel de navegação principal, selecione Portais.
Escolha um portal.
Copie o nome de domínio padrão do portal ou o nome do domínio e insira-o em um navegador.
-
Na página inicial do portal, você pode pesquisar produtos do portal e descobrir páginas de produtos. Utilize a pesquisa na parte superior do portal para pesquisar todo o conteúdo no seu portal. Utilize a barra de pesquisa em Produtos para pesquisar produtos do portal.
Escolha um produto do portal.
Escolha um endpoint REST do produto.
Na janela Experimente, insira os parâmetros para testar uma chamada para sua API.
Escolha Experimente. O API Gateway invocará sua API e mostrará os resultados na janela.
Solucionar problemas no portal
O tópico a seguir fornece orientações para a solução de erros e problemas que você pode encontrar ao usar um portal.
O site da página da web do portal não pode ser acessado
Se você receber uma mensagem de erro informando que o site da página do portal não pode ser acessado, verifique se publicou o portal. Se você usou um nome de domínio, verifique se adicionou o registro de alias que o API Gateway forneceu para encaminhar o tráfego para a distribuição do CloudFront para seu domínio personalizado.
O recurso Experimente falhou
Se você não conseguir usar o recurso Experimente de um endpoint REST do produto, verifique se o estado dele é ACTIVE. Além disso, verifique se você inseriu os parâmetros corretos para invocar sua API.
As páginas não aparecem no portal
Se você criou uma página de endpoint REST de produto ou uma página de produto e ela não está visível em seu portal, verifique se suas páginas não estão no modo de rascunho. Para verificar isso, faça o seguinte:
Como verificar se suas páginas não estão modo de rascunho
Inicie uma sessão no console do API Gateway em https://console.aws.amazon.com/apigateway
. No painel de navegação principal, selecione Produtos do portal.
Escolha o produto do portal.
Na guia Documentação, confirme se suas páginas não estão na seção Páginas de rascunho de documentação ou Páginas de referência de API de rascunho, mas sim nas Páginas de documentação personalizada ou Páginas de referência de API.
