Invocación de las API de REST en API Gateway - Amazon API Gateway
Obtención de la URL de invocación de una APIInvocación de una API

Invocación de las API de REST en 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://api-id.execute-api.region.amazonaws.com/stage/

donde api-id es el identificador de la API, region es la región de AWS y stage es el nombre de la 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 las API de REST en API Gateway.

Temas

Obtención de la URL de invocación de una API

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

Obtención de la URL de invocación de una API con la consola

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

Obtención de la URL de invocación de una API con la consola de API de REST

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

  2. Elija 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 la API.

    Después de crear la API de REST, la consola muestra la URL de invocación de la API.

  5. Para obtener la URL de invocación de una API para otro recurso de la API, expanda la etapa bajo el panel de navegación secundario y, a continuación, elija un método.

  6. Elija el icono de copiar para copiar la URL de invocación en el nivel de recursos de la API.

    La URL en el nivel de recursos de la API de REST se encuentra en el panel de navegación secundario de la etapa.

Obtención de la URL de invocación de una API con la AWS CLI

En el siguiente procedimiento se muestra cómo obtener la URL de invocación de una API con la AWS CLI.

Obtención de la URL de invocación de una API con la AWS CLI

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

    aws apigateway get-rest-apis

  2. Sustituya rest-api-id del ejemplo por su rest-api-id, sustituya {stage-name} del ejemplo por su {stage-name} y sustituya {region} por su región.

    https://{restapi_id}.execute-api.{region}.amazonaws.com/{stage_name}/
Obtención de 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 campos host y basePath de un archivo de definición de OpenAPI exportado de la API. Para obtener instrucciones acerca de cómo exportar la API, consulte Exportación de una API REST desde API Gateway.

Invocación de una API

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

Además, puede utilizar la consola de API Gateway para probar una llamada a la API. La prueba utiliza la característica TestInvoke 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 %%.

Invocación de una API mediante un navegador web

Si la API permite el acceso anónimo, puede utilizar cualquier navegador web para invocar cualquier método GET. Ingrese la URL de invocación completa en la barra de dirección del navegador.

Para otros métodos o para todas las llamadas que requieran autenticación, debe especificar una carga o firmar las solicitudes. Puede realizar esto en un script detrás de una página HTML o en una aplicación cliente mediante uno de los SDK de AWS.

Invocación de una API mediante curl

Puede usar una herramienta como curl en el terminal para llamar a la API. El siguiente comando curl de ejemplo invoca el método GET en el recurso getUsers de la fase prod 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"