Creación de una página de producto en API Gateway
Una página del producto ayuda a los consumidores de los productos a entender y utilizar los productos. La documentación se encuentra por producto, por lo que todos los portales que incluyan el producto disponen de esta documentación. API Gateway admite dos tipos de páginas de productos escritas en GitHub Flavored Markdown
- Página de información general
-
Al crear el producto, API Gateway genera automáticamente una página de Información general del producto en función de la información que proporciona al crear el producto. Esta página tiene un formato adicional que no se puede cambiar. Puede modificar el texto o eliminar la página del producto del portal.
- Páginas personalizadas
-
Una página personalizada es una página escrita en Markdown. Puede usar esta sección para ver los términos y condiciones o un tutorial sobre cómo usar el producto. Puede convertir cualquier página personalizada en una página de información general. Al convertir una página personalizada en una página de información general, el contenido de la página tiene un formato que coincide con el de la página de información general.
Consideraciones
Las siguientes consideraciones pueden afectar al uso de las páginas de productos:
-
Esta documentación no se encuentra por API y no incluye ningún método, recurso ni parámetro de solicitud. Para obtener información sobre cómo modificar la documentación por API de un producto, consulte Actualización de un punto de conexión REST del producto en API Gateway.
-
No puede cargar un archivo
.mddirectamente en el producto. -
Puede modificar el orden de las páginas de productos modificando la lista de páginas en el orden de visualización del producto del portal. Para obtener más información, consulte Actualización de un producto del portal en API Gateway.
-
Debe volver a publicar todos los portales que incluyan el producto para que los cambios en la documentación surtan efecto.
-
Si tiene varios portales que utilizan el mismo producto del portal, las páginas del producto son las mismas en todos los portales. Para tener los mismos puntos de conexión REST del producto pero diferentes páginas de productos, cree varios productos.
Creación de una página de producto
El siguiente procedimiento muestra cómo crear una página de producto.
Creación de una página de producto
Inicie sesión en la consola de API Gateway, en https://console.aws.amazon.com/apigateway
. En el panel de navegación principal, elija Productos de portales.
Elija un producto.
En Documentación, elija Crear página personalizada.
Para Título de la página, ingrese el título de la página.
Para Cuerpo, ingrese la documentación complementaria mediante GitHub Flavored Markdown.
La sección de vista previa muestra cómo aparece el contenido en un portal. El estilo visual final puede cambiar en función de la configuración del portal.
Elija Crear página del producto.
-
La página del producto es ahora un borrador. Elija Borradores de páginas de documentación y, a continuación, elija la página del producto para finalizar el contenido de la página.
Elija Editar página.
-
Para Nombre de sección, ingrese un nombre o elija una sección existente. Al agregar la página del producto a una sección, los consumidores pueden ver el contenido en un portal publicado.
Seleccione Save changes (Guardar cambios).
Para que los consumidores puedan ver la nueva página, igual tendrá que volver a publicar el portal. Para obtener más información, consulte Publicación de un portal en API Gateway.
