Depuración de una API

Escenario

Después de crear una API, depurarla en la consola API Gateway estableciendo los encabezados HTTP y los parámetros del cuerpo para verificar si la API se está ejecutando normalmente.

• Las API con rutas de solicitud de backend que contienen variables no se pueden depurar.
• Si una API se ha vinculado con una política de limitación de solicitudes, la política no funcionará durante la depuración de la API.

Prerrequisitos

• Ha creado un grupo de API y una API.
• Ha configurado el servicio de backend de la API.

Procedimiento

1. Inicie sesión en la consola de gestión.
2. Haga clic en en la esquina superior izquierda y seleccione una región.
3. Haz clic en en la esquina superior izquierda y elige API Gateway.
4. Elija un tipo de puerta de enlace en el panel de navegación.
   • Shared Gateway: puede crear y gestionar API de inmediato. Se le facturará en función del número de llamadas API.
   • Dedicated Gateways: puede crear y gestionar API después de comprar una puerta de enlace. Se le facturará en función de la duración del uso del gateway.

5. En el panel de navegación, elija API Publishing > APIs.
6. Depurar una API. Puede utilizar uno de los métodos siguientes:
   • En la columna Operation de la API que desea depurar, elija More > Debug.
   • Haz clic en el nombre de la API de destino y haz clic en Debug en la esquina superior derecha de la página de detalles de la API mostrada.
   Figura 1 Depuración de una API
   

   En el lado izquierdo, establece los parámetros de solicitud de API enumerados en Tabla 1. En el lado derecho, consulta la información de solicitud y respuesta de la API después de hacer clic en Send Request.

   Tabla 1 Parámetros para la depuración de una API

   Parámetro	Descripción
   Protocol	Este parámetro solo se puede modificar si se establece Protocol en HTTP&HTTPS para la API.
   Method	Este parámetro solo se puede modificar si estableces Method en ANY para la API.
   Suffix	Puede definir una ruta solo si ha establecido Matching a Prefix match para la API.
   Path	Ruta de solicitud de la API.
   Path Parameters	Este parámetro solo se puede modificar si ha definido parámetros de ruta (como {test}) para la API.
   Headers	Encabezados y valores HTTP.
   Query Strings	Parámetros y valores de la cadena de consulta.
   Body	Este parámetro solo se puede modificar si establece Method en PATCH, POST o PUT para la API.

   

   Los campos mostrados en la página de depuración varían según el tipo de solicitud.

7. Después de establecer los parámetros de solicitud, haga clic en Send Request.

   El cuadro en la parte inferior derecha muestra la respuesta de la solicitud de API.

   • Si la depuración tiene éxito, se muestran el código 200 de estado HTTP y los detalles de respuesta.
   • Si la solicitud no se envía, se muestra un código de estado HTTP 4xx o 5xx. Para más detalles, consulte Códigos de error.

8. Puede enviar más solicitudes con diferentes parámetros y valores para verificar la API.
   

   Para modificar las configuraciones de la API, haz clic en Edit en la esquina superior derecha y modifica los parámetros en la página Edit API.

Operaciones de seguimiento

Una vez que la API se haya depurado correctamente, publique la API en un entorno específico para que los usuarios puedan llamar a la API. Para garantizar la seguridad de la API, cree directivas de limitación de solicitudes (consulte Creación de una política de limitación de solicitudes), políticas de control de acceso (Creación de una política de control de acceso), y claves de firma (Creación y uso de una clave de firma) para la API.