Ejecute API Gateway de forma local con AWS SAM

La ejecución local de Amazon API Gateway puede tener diversas ventajas. Por ejemplo, ejecutar API Gateway de forma local te permite probar los puntos finales de la API de forma local antes de implementarlos AWS en la nube. Si primero realiza las pruebas a nivel local, a menudo puede reducir las pruebas y el desarrollo en la nube, lo que puede ayudar a reducir los costes. Además, la ejecución local facilita la depuración.

Para iniciar una instancia local de API Gateway que puedas usar para probar la funcionalidad de solicitud/respuesta HTTP, usa el comando. sam local start-api AWS SAMCLI Esta funcionalidad incluye la recarga en caliente para que pueda desarrollar e iterar rápidamente sus características.

nota

La recarga en caliente se produce cuando solo se actualizan los archivos que se han modificado y el estado de la aplicación sigue siendo el mismo. Por el contrario, la recarga en tiempo real se produce cuando se actualiza toda la aplicación y se pierde su estado.

Para obtener instrucciones sobre cómo utilizar el comando sam local start-api, consulte Introducción a las pruebas con sam local start-api.

De forma predeterminada, AWS SAM usa integraciones de AWS Lambda proxy y es compatible con ambos HttpApi tipos de recursos. Api Para obtener más información sobre las integraciones de proxy para los tipos de HttpApi recursos, consulte Cómo trabajar con integraciones de AWS Lambda proxy para las API HTTP en la Guía para desarrolladores de API Gateway. Para obtener más información sobre las integraciones de proxy para los tipos de recursos Api, consulte Cómo trabajar con integraciones de proxy Lambda de API Gateway en la Guía para desarrolladores de API Gateway.

Ejemplo:

$ sam local start-api

AWS SAM busca automáticamente todas las funciones de la AWS SAM plantilla que tengan definidas las fuentes de Api eventos HttpApi o las fuentes de eventos. A continuación, monta la función en las rutas HTTP definidas.

En el ejemplo de Api siguiente, la función Ratings monta ratings.py:handler() en /ratings para las solicitudes GET.

Ratings:
  Type: AWS::Serverless::Function
  Properties:
    Handler: ratings.handler
    Runtime: python3.9
    Events:
      Api:
        Type: Api
        Properties:
          Path: /ratings
          Method: get

Aquí tiene un ejemplo de Api de respuesta:

// Example of a Proxy Integration response
exports.handler = (event, context, callback) => {
    callback(null, {
        statusCode: 200,
        headers: { "x-custom-header" : "my custom header value" },
        body: "hello world"
    });
}

Si modifica el código de la función, ejecute el comando sam build para sam local start-api para detectar los cambios.

Archivo de variables de entorno

Para declarar localmente las variables de entorno que anulan los valores definidos en las plantillas, haga lo siguiente:

1. Cree un archivo JSON que contenga las variables de entorno que desee anular.

2. Use el argumento --env-vars para anular los valores definidos en sus plantillas.

Declaración de variables de entorno

Para declarar variables de entorno que se apliquen globalmente a todos los recursos, especifique un objeto Parameters como el siguiente:

{
    "Parameters": {
        "TABLE_NAME": "localtable",
        "BUCKET_NAME": "testBucket",
        "STAGE": "dev"
    }
}

Para declarar variables de entorno diferentes para cada recurso, especifique objetos para cada recurso de la siguiente manera:

{
    "MyFunction1": {
        "TABLE_NAME": "localtable",
        "BUCKET_NAME": "testBucket",
    },
    "MyFunction2": {
        "TABLE_NAME": "localtable",
        "STAGE": "dev"
    }
}

Al especificar objetos para cada recurso, puede utilizar los siguientes identificadores, enumerados en orden de mayor a menor prioridad:

1. logical_id

2. function_id

3. function_name

4. Identificador de ruta completo

Puede utilizar los dos métodos anteriores para declarar variables de entorno juntos en un único archivo. Al hacerlo, las variables de entorno que haya proporcionado para recursos específicos tienen prioridad sobre las variables de entorno globales.

Guarde las variables de entorno en un archivo JSON, como env.json.

Anulación de valores de variables de entorno

Para anular las variables de entorno por las definidas en el archivo JSON, utilice el argumento --env-vars con los comandos invoke o start-api. Por ejemplo:

$ sam local start-api --env-vars env.json

Capas

Si su aplicación incluye capas, para obtener información sobre cómo depurar los problemas con las capas de su host local, consulte Aumente la eficiencia con las capas Lambda con AWS SAM.