Criar um produto do portal no API Gateway - Amazon API Gateway
ConsideraçõesCriar um produto do portal

Criar um produto do portal no API Gateway

O procedimento a seguir mostra como criar um produto do portal. Portal é uma coleção de produtos do portal. Depois de criar seu produto do portal, você vai criar endpoints REST e as páginas do produto. Para saber mais sobre como produtos do portal, consulte Produtos de portal no API Gateway.

Considerações

As considerações a seguir podem afetar a maneira como você cria um produto do portal:

  • Seu produto do portal pode conter APIs REST privadas e públicas. As APIs privadas não comportam o recurso Experimente e, como resultado, têm uma diferença visual em seu portal. Como proprietário do portal, talvez você precise fornecer uma documentação para explicar isso.

  • Se você criar seu produto do portal usando a AWS CLI ou AWS SDKs, seu portal não terá nenhum endpoint nem páginas do produto. Você precisa adicionar esses recursos utilizando a AWS CLI ou o console. Para saber como criar um endpoint REST do produto, consulte Criar um endpoint REST de produto no API Gateway. Para saber como criar uma função para um serviço, consulteCriar uma página do produto no API Gateway.

Criar um produto do portal

O procedimento a seguir mostra como criar um produto do portal.

Como criar um produto do portal

  1. Inicie uma sessão no console do API Gateway em https://console.aws.amazon.com/apigateway.

  2. No painel de navegação principal, selecione Produtos do portal.

  3. Escolha Criar produto.

  4. Em Nome do projeto, digite o nome de seu produto do portal.

  5. Em Descrição do produto, insira uma descrição.

  6. Escolha Next (Próximo).

  7. Para selecionar os endpoints REST do seu produto, em Endpoints de API, escolha uma API e, depois, selecione um estágio.

  8. Para adicionar um endpoint aos endpoints REST do produto, selecione o endpoint de API e escolha Adicionar ao produto.

    nota

    Não escolha Próximo sem primeiro selecionar Adicionar ao produto.

    Produto do portal

    O endpoint de API aparecerá na lista Endpoints de API selecionados.

  9. Escolha Next (Próximo).

  10. Analise sua seleção e escolha Criar produto.

Depois de criar seu produto do portal usando o console, todas as suas páginas do produto e páginas de endpoint REST estarão no modo de rascunho e não aparecerão no portal. Para que as páginas do produto e as páginas de endpoint REST fiquem visíveis para os consumidores, você precisa adicionar seu rascunho a uma seção. Se você criar o produto do portal utilizando a AWS CLI ou AWS SDKs, precisará adicionar o rascunho à seção no comando AWS CLI. Independentemente de como você adiciona seu rascunho a uma seção, precisará publicar o portal que usa seus produtos para que ele fique visível para os consumidores.

Como adicionar seu rascunho a uma seção da página

  1. Seus rascunhos estão listados na guia Documentação. Há páginas de documentação de rascunho para as páginas do produto e páginas de referência de API de rascunho para as páginas de endpoint REST do produto. Escolha as páginas de referência de API de rascunho.

  2. Escolha a página de referência de API de rascunho.

    Se você não tiver nenhum endpoint REST de produto, não terá nenhuma página de referência de API de rascunho. Para saber como criar um endpoint REST do produto, consulte Criar um endpoint REST de produto no API Gateway.

  3. Selecione Editar página.

  4. Nessa página, você pode substituir qualquer parte existente da documentação da API ou usar a documentação do API Gateway. Para permitir que o conteúdo da página de endpoint REST do seu produto fique visível para os consumidores, em Nome da seção, insira um nome. Se esse fosse o endpoint /pets-GET, o nome da página poderia ser Pets.

  5. Escolha Salvar alterações.

  6. O novo nome da página que você criou aparece na seção Páginas de referência de API.

    Para permitir que a nova página fique visível para os consumidores, você ainda precisa publicar novamente o portal. Para obter mais informações, consulte Publicar um portal no API Gateway.