Habilitación de una prueba para un punto de conexión REST de un producto de API Gateway en el portal - Amazon API Gateway

Habilitación de una prueba para un punto de conexión REST de un producto de API Gateway en el portal

Use la prueba para permitir que un consumidor de API invoque el punto de conexión del producto desde el portal. Cuando un consumidor de la API utiliza la prueba, ingresa los parámetros de solicitud del método e invoca el punto de conexión del producto. A continuación, API Gateway invoca la API a través de Internet pública y devuelve la respuesta en la ventana de la prueba. Puede usar una página de producto personalizada para proporcionar cualquier información adicional sobre los parámetros necesarios para acceder a la API.

API Gateway utiliza los siguientes límites para proteger las API:

  • API Gateway solo permite 3 solicitudes por segundo a la API.

  • API Gateway utiliza un límite de tiempo de espera integrado de 29 000 ms. Es posible que la API actual tenga un límite de tiempo de espera más alto, pero API Gateway no aplica este tiempo de espera cuando un cliente usa la prueba.

  • API Gateway limita la carga útil de respuesta a 6 MB.

Consideraciones

Las siguientes consideraciones pueden afectar a cómo usar la prueba:

  • La prueba no es compatible con la vista previa de un portal.

  • La prueba no es compatible para las API de REST con las siguientes características:

    • API privadas

    • API que utilizan TLS mutuo

    • API que utilizan certificados SSL privados o autofirmados

    Como propietario del portal, es responsable de la comunicación con los consumidores de la API. El motivo por el que usar el botón de prueba no existe para ninguna API de REST que no sea compatible. API Gateway no le explica esto.

Habilitación de la prueba para un punto de conexión REST de un producto

En el siguiente procedimiento, se muestra cómo habilitar la prueba para un punto de conexión de producto.

Para obtener información sobre cómo utilizar la prueba en un portal, consulte Uso de un portal de API Gateway.

Habilitación de la prueba para un punto de conexión REST de un producto
  1. En el panel de navegación principal, elija Productos de portales.

  2. Elija un producto.

  3. En la pestaña Documentación, en las páginas de referencia de la API, elija el nombre del punto de conexión REST de un producto, como /dogs - GET.

  4. Elija Editar página.

  5. Para permitir que los clientes invoquen la API en el portal, seleccione la funcionalidad de la prueba.

  6. Seleccione Save changes (Guardar cambios).

  7. Para que los cambios surtan efecto, es necesario volver a publicar cualquier portal que utilice este producto de portal.