diff --git a/README.md b/README.md index 4ad46bbf4..b408db7c0 100644 --- a/README.md +++ b/README.md @@ -106,6 +106,7 @@ serverless install -u https://github.com/serverless/examples/tree/master/folder- | [Aws Nodejs Websockets Authorizers](https://github.com/serverless/examples/tree/master/aws-node-websockets-authorizers)
Simple example that demonstrates how to use authorizer functions with websocket events | nodeJS | | [Aws Alexa Skill](https://github.com/serverless/examples/tree/master/aws-python-alexa-skill)
This example demonstrates how to use an AWS Lambdas for your custom Alexa skill. | python | | [Aws Auth0 Api Gateway](https://github.com/serverless/examples/tree/master/aws-python-auth0-custom-authorizers-api)
Demonstration of protecting API gateway endpoints with auth0 | python | +| [Aws Python Flask Api](https://github.com/serverless/examples/tree/master/aws-python-flask-api)
Example of a Python Flask API service with traditional Serverless Framework | python | | [Aws Python Line Echo Bot](https://github.com/serverless/examples/tree/master/aws-python-line-echo-bot)
this is echo bot on LINE message | python | | [Aws Python Pynamodb S3 Sigurl](https://github.com/serverless/examples/tree/master/aws-python-pynamodb-s3-sigurl)
Serverless signed uploader REST API using pynamodb, s3 generated events, custom log format, and DRY serverless.yml with custom section | python | | [Aws Rest With Dynamodb](https://github.com/serverless/examples/tree/master/aws-python-rest-api-with-dynamodb)
Serverless CRUD service exposing a REST HTTP interface | python | diff --git a/aws-python-flask-api/README.md b/aws-python-flask-api/README.md new file mode 100644 index 000000000..5a2d13604 --- /dev/null +++ b/aws-python-flask-api/README.md @@ -0,0 +1,151 @@ + + +# 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 `http` events. To learn more about `http` event configuration options, please refer to [http event docs](https://www.serverless.com/framework/docs/providers/aws/events/apigateway/). 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 then perform deployment with: + +``` +serverless deploy +``` + +After running deploy, you should see output similar to: + +```bash +erverless: Using Python specified in "runtime": python3.8 +Serverless: Packaging Python WSGI handler... +Serverless: Generated requirements from /home/xxx/xxx/xxx/examples/aws-python-flask-api/requirements.txt in /home/xxx/xxx/xxx/examples/aws-python-flask-api/.serverless/requirements.txt... +Serverless: Using static cache of requirements found at /home/xxx/.cache/serverless-python-requirements/62f10436f9a1bb8040df30ef2db5736c8015b18256bf0b6f1b0cbb2640030244_slspyc ... +Serverless: Packaging service... +Serverless: Excluding development dependencies... +Serverless: Injecting required Python packages to package... +Serverless: Creating Stack... +Serverless: Checking Stack create progress... +........ +Serverless: Stack create finished... +Serverless: Uploading CloudFormation file to S3... +Serverless: Uploading artifacts... +Serverless: Uploading service aws-python-flask-api.zip file to S3 (1.3 MB)... +Serverless: Validating template... +Serverless: Updating Stack... +Serverless: Checking Stack update progress... +................................. +Serverless: Stack update finished... +Service Information +service: aws-python-flask-api +stage: dev +region: us-east-1 +stack: aws-python-flask-api-dev +resources: 12 +api keys: + None +endpoints: + ANY - https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/ + ANY - https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/{proxy+} +functions: + api: aws-python-flask-api-dev-api +layers: + None +``` + +_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 [http event docs](https://www.serverless.com/framework/docs/providers/aws/events/apigateway/). + +### 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). diff --git a/aws-python-flask-api/app.py b/aws-python-flask-api/app.py new file mode 100644 index 000000000..9f09f9f4e --- /dev/null +++ b/aws-python-flask-api/app.py @@ -0,0 +1,18 @@ +from flask import Flask, jsonify, make_response + +app = Flask(__name__) + + +@app.route("/") +def hello_from_root(): + return jsonify(message='Hello from root!') + + +@app.route("/hello") +def hello(): + return jsonify(message='Hello from path!') + + +@app.errorhandler(404) +def resource_not_found(e): + return make_response(jsonify(error='Not found!'), 404) diff --git a/aws-python-flask-api/package.json b/aws-python-flask-api/package.json new file mode 100644 index 000000000..4c1f7bd5c --- /dev/null +++ b/aws-python-flask-api/package.json @@ -0,0 +1,10 @@ +{ + "name": "aws-python-flask-api", + "version": "1.0.0", + "description": "Example of a Python Flask API service with traditional Serverless Framework", + "author": "", + "devDependencies": { + "serverless-python-requirements": "^5.1.0", + "serverless-wsgi": "^1.7.6" + } +} diff --git a/aws-python-flask-api/requirements.txt b/aws-python-flask-api/requirements.txt new file mode 100644 index 000000000..46a48dd97 --- /dev/null +++ b/aws-python-flask-api/requirements.txt @@ -0,0 +1 @@ +Flask==1.1.2 diff --git a/aws-python-flask-api/serverless.yml b/aws-python-flask-api/serverless.yml new file mode 100644 index 000000000..9e9b49779 --- /dev/null +++ b/aws-python-flask-api/serverless.yml @@ -0,0 +1,31 @@ +service: aws-python-flask-api + +frameworkVersion: '2' +variablesResolutionMode: '20210219' +configValidationMode: 'error' + +custom: + wsgi: + app: app.app + +provider: + name: aws + runtime: python3.8 + lambdaHashingVersion: '20201221' + apiGateway: + shouldStartNameWithService: true + +functions: + api: + handler: wsgi_handler.handler + events: + - http: + path: / + method: ANY + - http: + path: /{proxy+} + method: ANY + +plugins: + - serverless-wsgi + - serverless-python-requirements