Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jeffhollan/serverless-lambda-flask-api

aws-python-flask-api-project
https://github.com/jeffhollan/serverless-lambda-flask-api

Last synced: 3 days ago
JSON representation

aws-python-flask-api-project

Awesome Lists containing this project

README 

        



# Serverless Framework Python Flask API on AWS



This template demonstrates how to develop and deploy a simple Python Flask API service running on AWS Lambda using the traditional Serverless Framework.



## Anatomy of the template



This template configures a single function, `api`, which is responsible for handling all incoming requests thanks to configured `httpApi` events. To learn more about `httpApi` event configuration options, please refer to [httpApi event docs](https://www.serverless.com/framework/docs/providers/aws/events/http-api/). As the events are configured in a way to accept all incoming requests, `Flask` framework is responsible for routing and handling requests internally. The implementation takes advantage of `serverless-wsgi`, which allows you to wrap WSGI applications such as Flask apps. To learn more about `serverless-wsgi`, please refer to corresponding [GitHub repository](https://github.com/logandk/serverless-wsgi). Additionally, the template relies on `serverless-python-requirements` plugin for packaging dependencies from `requirements.txt` file. For more details about `serverless-python-requirements` configuration, please refer to corresponding [GitHub repository](https://github.com/UnitedIncome/serverless-python-requirements).



## Usage



### Prerequisites



In order to package your dependencies locally with `serverless-python-requirements`, you need to have `Python3.8` installed locally. You can create and activate a dedicated virtual environment with the following command:



```bash

python3.8 -m venv ./venv

source ./venv/bin/activate

```



Alternatively, you can also use `dockerizePip` configuration from `serverless-python-requirements`. For details on that, please refer to corresponding [GitHub repository](https://github.com/UnitedIncome/serverless-python-requirements).



### Deployment



This example is made to work with the Serverless Framework dashboard, which includes advanced features such as CI/CD, monitoring, metrics, etc.



In order to deploy with dashboard, you need to first login with:



```

serverless login

```



install dependencies with:



```

npm install

```



and



```

pip install -r requirements.txt

```



and then perform deployment with:



```

serverless deploy

```



After running deploy, you should see output similar to:



```bash

Deploying aws-python-flask-api-project to stage dev (us-east-1)



✔ Service deployed to stack aws-python-flask-api-project-dev (182s)



endpoint: ANY - https://xxxxxxxx.execute-api.us-east-1.amazonaws.com

functions:

  api: aws-python-flask-api-project-dev-api (1.5 MB)

```



_Note_: In current form, after deployment, your API is public and can be invoked by anyone. For production deployments, you might want to configure an authorizer. For details on how to do that, refer to [httpApi event docs](https://www.serverless.com/framework/docs/providers/aws/events/http-api/).



### Invocation



After successful deployment, you can call the created application via HTTP:



```bash

curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/

```



Which should result in the following response:



```

{"message":"Hello from root!"}

```



Calling the `/hello` path with:



```bash

curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/hello

```



Should result in the following response:



```bash

{"message":"Hello from path!"}

```



If you try to invoke a path or method that does not have a configured handler, e.g. with:



```bash

curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/nonexistent

```



You should receive the following response:



```bash

{"error":"Not Found!"}

```



### Local development



Thanks to capabilities of `serverless-wsgi`, it is also possible to run your application locally, however, in order to do that, you will need to first install `werkzeug` dependency, as well as all other dependencies listed in `requirements.txt`. It is recommended to use a dedicated virtual environment for that purpose. You can install all needed dependencies with the following commands:



```bash

pip install werkzeug

pip install -r requirements.txt

```



At this point, you can run your application locally with the following command:



```bash

serverless wsgi serve

```



For additional local development capabilities of `serverless-wsgi` plugin, please refer to corresponding [GitHub repository](https://github.com/logandk/serverless-wsgi).