Criar uma página do produto no API Gateway
Uma página de produto ajuda seus consumidores a entender e usar seus produtos. A documentação está em nível de produto, portanto, todos os portais que incluem seu produto têm essa documentação. O API Gateway comporta dois tipos de páginas de produtos escritas no GitHub Flavored Markdown
- Página Visão geral
-
Quando você cria seu produto, o API Gateway gera automaticamente uma página Visão geral para seu produto com base nas informações que você fornece ao criar seu produto. Essa página tem uma formatação adicional que não pode ser alterada. Você pode modificar o texto ou remover a página do produto do portal.
- Páginas personalizadas
-
Página personalizada é uma página escrita em Markdown. Você pode usar essa seção para ver os termos e condições ou um tutorial sobre como usar seu produto. Você pode transformar qualquer página personalizada em uma página de visão geral. Quando você transforma uma página personalizada em uma página de visão geral, o conteúdo da página é formatado para corresponder à página de visão geral.
Considerações
As considerações a seguir podem afetar o uso de páginas do produto:
-
Essa documentação não está em nível de API e não inclui métodos, recursos ou parâmetros de solicitação. Para saber como modificar a documentação em nível de API de um produto, consulte Atualizar um endpoint REST de um produto no API Gateway.
-
Você não pode fazer upload diretamente de um arquivo
.mdpara o seu produto. -
É possível modificar a ordem das páginas do produto modificando a lista de páginas na ordem de exibição do seu produto do portal. Para obter mais informações, consulte Atualizar um produto do portal no API Gateway.
-
Você precisa publicar novamente todos os portais que incluam seu produto para que as alterações na documentação sejam implementadas.
-
Se você tiver vários portais que usam o mesmo produto, as páginas do produto serão as mesmas em todos os portais. Para ter os mesmos endpoints REST do produto, mas páginas de produto diferentes, crie vários produtos.
Criar uma página de produto
O procedimento a seguir mostra como criar um produto do produto.
Como criar uma página do produto
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 um produto.
Em Documentação, escolha Criar página personalizada.
Em Título da página, insira o título da página.
Em Corpo, insira sua documentação complementar usando o GitHub Flavored Markdown.
A seção Versão prévia mostra como seu conteúdo aparece em um portal. O estilo visual final pode mudar com base nas configurações do seu portal.
Escolha Criar página do produto.
-
Sua página do produto agora está no modo de rascunho. Escolha Páginas de documentação de rascunho e, depois, escolha a página do produto para finalizar o conteúdo dela.
Selecione Editar página.
-
Em Nome da seção, insira um nome ou escolha uma seção existente. Quando você adiciona a página a uma seção, os consumidores podem visualizar seu conteúdo em um portal publicado.
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.
