Criar um endpoint REST de produto no API Gateway - Amazon API Gateway
Criar um endpoint REST de produto

Criar um endpoint REST de produto no API Gateway

Um endpoint REST do produto é um ponto de acesso ao seu produto do portal. Cada endpoint consiste no caminho e no método de uma API REST e no estágio em que ela é implantada. O endpoint inclui qualquer documentação que você definiu para sua API REST ou pode ser atualizado com documentação personalizada. Ao criar o endpoint REST do produto, você define as seguintes configurações:

  • O nome da operação do endpoint REST do produto. Se sua API REST tiver o caminho e o método GET /pets, em um portal, o nome será /pets. Usando o nome da operação, você pode alterar o nome do endpoint REST do produto para Pet summaries. Isso não afeta sua API existente.

  • O recurso Experimente para o endpoint do seu produto. Isso permite que os consumidores de API experimentem as APIs em seu portal. Se você criar um endpoint de produto para uma API privada, o recurso Experimente será definido como UNAVAILABLE. Para obter mais informações, consulte Habilitar o botão Experimente para um endpoint REST do produto do API Gateway em seu portal.

  • Se você atualmente tem partes de documentação definidas para sua API REST, poderá importar a documentação ou substituir a existente e criar outra em nível de produto utilizando o GitHub Flavored Markdown. A substituição de documentação não é propagada de volta para as partes da documentação da API do API Gateway. Se você importar suas partes da documentação atual, o API Gateway sincronizará as alterações em sua API com o endpoint REST do produto.

Criar um endpoint REST de produto

O procedimento a seguir mostra como adicionar um endpoint REST de um produto a um produto do portal existente. Para saber como criar um produto do portal e um endpoint REST do produto juntos, consulte Criar um produto do portal no API Gateway.

Como criar um endpoint REST de produto para um portal de produtos

  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 um produto do portal.

  4. Escolha a guia Endpoints associados e, depois, Adicionar endpoints.

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

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

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

  7. Selecione Enviar.

  8. A página de endpoint REST do produto agora é um rascunho. Escolha Páginas de referência de API de rascunho e, depois, escolha a página do endpoint REST do produto para finalizar o conteúdo da página.

  9. Selecione Editar página.

  10. Para substituir a documentação existente do API Gateway, em Fonte de documentação, ative Substituir a documentação e faça o seguinte:

    1. Em Exibir conteúdo, escolha Criar substituição.

    2. Em Nome da operação, insira um novo nome de operação.

    3. Em Corpo da página, insira sua documentação personalizada.

    4. (Opcional) Em Endpoint, insira um endpoint personalizado que aparece no seu portal.

  11. Para permitir que os clientes invoquem sua API no portal, selecione Recurso Experimente. Para obter mais informações, consulte Habilitar o botão Experimente para um endpoint REST do produto do API Gateway em seu portal.

  12. Em Nome da seção, insira um nome ou escolha uma seção existente. Quando você adiciona o endpoint REST do seu produto a uma seção, os consumidores podem visualizar seu conteúdo em um portal publicado.

  13. Escolha Salvar alterações.

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.