Invocación de una API REST en Amazon API Gateway

Para llamar a una API implementada, los clientes envían solicitudes a la URL del servicio del componente de API Gateway para la ejecución de API, denominado execute-api.

La URL base de las API de REST tiene el siguiente formato:

https://restapi_id.execute-api.region.amazonaws.com/stage_name/

donde restapi_id es el identificador de la API, region es la AWS región y stage_name es el nombre de etapa de la implementación de la API.

importante

Antes de poder invocar una API, debe implementarla en API Gateway. Para obtener instrucciones sobre cómo implementar una API, consulte. Implementación de una API de REST en Amazon API Gateway

Temas

• Obtener la URL de invocación de una API
• Invocación de una API
• Uso de la consola de API Gateway para probar un método de la API REST
• Cómo llamar a una API de REST a través de los SDK generados
• Cómo invocar una API privada

Obtener la URL de invocación de una API

Puedes usar la consola AWS CLI, la o una definición de OpenAPI exportada para obtener la URL de invocación de una API.

Obtener la URL de invocación de una API mediante la consola

El siguiente procedimiento muestra cómo obtener la URL de invocación de una API en la consola de la API REST.

Para obtener la URL de invocación de una API mediante la consola de la API REST

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

2. Elige una API implementada.

3. En el panel de navegación principal, elija Etapa.

4. En Detalles de la etapa, elija el icono de copia para copiar la URL de invocación de la API.

   Esta URL es para el recurso raíz de tu API.

   

5. Para obtener la URL de invocación de una API para otro recurso de tu API, expande la etapa situada debajo del panel de navegación secundario y, a continuación, elige un método.

6. Selecciona el icono de copia para copiar la URL de invocación a nivel de recursos de tu API.

   

Obtener la URL de invocación de una API mediante AWS CLI

El siguiente procedimiento muestra cómo obtener la URL de invocación de una API mediante. AWS CLI

Para obtener la URL de invocación de una API mediante AWS CLI

1. Utilice el siguiente comando para obtener elrest-api-id. Este comando devuelve todos los rest-api-id valores de su región. Para obtener más información, consulte get-rest-apis.

   aws apigateway get-rest-apis

2. Sustituya el ejemplo por rest-api-id el rest-api-id suyo, sustituya el ejemplo {nombre-fase} por su {nombre-fase} y sustituya la {región} por su región.

   https://{restapi_id}.execute-api.{region}.amazonaws.com/{stage_name}/

Obtener la URL de invocación de una API mediante el archivo de definición de OpenAPI exportado de la API

También puede crear la URL raíz combinando los basePath campos host y de un archivo de definición de OpenAPI exportado de la API. Para obtener instrucciones sobre cómo exportar tu API, consultaExportación de una API REST desde API Gateway.

Invocación de una API

Puedes llamar a la API implementada mediante el navegador, curl u otras aplicaciones, como Postman.

Además, puede usar la consola API Gateway para probar una llamada a la API. La prueba utiliza la TestInvoke función de API Gateway, que permite probar la API antes de que se implemente la API. Para obtener más información, consulte Uso de la consola de API Gateway para probar un método de la API REST.

nota

Los valores de los parámetros de cadenas de consulta en una URL de invocación no pueden contener %%.

Invocar una API mediante un navegador web

Si tu API permite el acceso anónimo, puedes usar cualquier navegador web para invocar cualquier GET método. Introduce la URL de invocación completa en la barra de direcciones del navegador.

Para otros métodos o cualquier llamada que requiera autenticación, debes especificar una carga útil o firmar las solicitudes. Puedes gestionarlos en un script detrás de una página HTML o en una aplicación cliente mediante uno de los SDK. AWS

Invocar una API mediante curl

Puedes usar una herramienta como curl en tu terminal para llamar a tu API. El siguiente ejemplo de comando curl invoca el método GET en el getUsers recurso de la prod fase de una API.

Linux or Macintosh

curl -X GET 'https://b123abcde4.execute-api.us-west-2.amazonaws.com/prod/getUsers'

Windows

curl -X GET "https://b123abcde4.execute-api.us-west-2.amazonaws.com/prod/getUsers"