Uso de un portal de API Gateway - Amazon API Gateway

Uso de un portal de API Gateway

Después de publicar el portal, estará disponible en la web. Para usar el portal, copie el nombre de dominio predeterminado del portal o el nombre de dominio e ingréselo en un navegador. Si el portal usa un nombre de dominio, el nombre de dominio predeterminado no se puede usar para acceder al portal.

Uso de un portal

En el siguiente procedimiento, se muestra cómo acceder a un portal y usar la prueba para un punto de conexión REST del producto.

Uso de un portal
  1. Inicie sesión en la consola de API Gateway, en https://console.aws.amazon.com/apigateway.

  2. En el panel de navegación principal, elija Portales.

  3. Elija un portal.

  4. Copie el nombre de dominio predeterminado del portal o el nombre de dominio e ingréselo en un navegador.

  5. En la página de inicio del portal, puede buscar productos del portal y detectar páginas de productos. Utilice la búsqueda en la parte superior del portal para buscar en todo el contenido del portal. Utilice la barra de búsqueda situada debajo de Productos para buscar los productos del portal.

  6. Elija un producto del portal.

  7. Elija un punto de conexión REST del producto.

  8. En la ventana Pruébelo, ingrese los parámetros para intentar llamar a la API.

  9. Elija Pruébelo. API Gateway invocará la API y mostrará los resultados en la ventana.

Solución de problemas del portal

A continuación, se le proporcionan consejos para solucionar errores y problemas que puedan surgir al utilizar un portal.

No se puede acceder al sitio de la página web del portal

Si recibe un mensaje de error que indica que no se puede acceder al sitio de la página web del portal, asegúrese de haber publicado el portal. Si usó un nombre de dominio, asegúrese de agregar el registro de alias que proporcionó API Gateway para dirigir el tráfico a la distribución de CloudFront para su dominio personalizado.

Prueba errónea

Si no puede usar la prueba para un punto de conexión REST del producto, asegúrese de que el estado de la prueba sea ACTIVE. Además, asegúrese de haber ingresado los parámetros correctos para invocar la API.

Las páginas no aparecen en el portal

Si ha creado una página de punto de conexión REST de un producto o una página de producto y no está visible en el portal, asegúrese de que las páginas no sean borradores. Para verificar esto, haga lo siguiente:

Comprobación de que las páginas no están en borradores
  1. Inicie sesión en la consola de API Gateway, en https://console.aws.amazon.com/apigateway.

  2. En el panel de navegación principal, elija Productos de portales.

  3. Elija el producto del portal.

  4. En la pestaña Documentación, confirme que las páginas no estén en la sección de borradores de páginas de documentación o borradores de páginas de referencia de la API, sino en las páginas de documentación personalizada o en las páginas de referencia de la API.