REST framework for serverless API (AWS Lambda + API Gateway)
Project description
pylambdarest
pylambdarest is a lightweight framework for building REST API using AWS Lambda + API Gateway.
Unlike most of other Python frameworks, it does not provide any routing capability. The routing should be handled by API Gateway itself.
Basically, it just provide a @route
decorator to parse the API Gateway event into a Request
object accessible from the handler function as an argument. It also formats the handler's output to the expected lambda + API Gateway format seamlessly.
Turning this:
import json
def handler(event, context):
body = json.loads(event["body"])
query_params = event["queryStringParameters"]
path_params = event["pathParameters"]
return {
"statusCode": 200,
"body": json.dumps({
"message": f"Hello from AWS Lambda {body['name']}!!"
})
}
Into this:
from pylambdarest import route
@route()
def handler(request):
body = request.json
query_params = request.query_params
path_params = request.path_params
return 200, {"message": f"Hello from AWS Lambda {body['name']}!!"}
You can still access the original event
, context
argument from the handler:
from pylambdarest import route
@route()
def handler(request, event, context):
print(event)
print(context)
body = request.json
params = request.params
return 200, {"message": f"Hello from AWS Lambda {body['name']}!!"}
pylambdarest also provides basic schema validation using jsonschema:
from pylambdarest import route
user_schema = {
"type": "object",
"properties": {
"name": {"type": "string"}
},
"required": ["name"],
"additionalProperties": False
}
@route(body_schema=user_schema)
def create_user(request):
# If the request's body does not
# satisfy the user_schema,
# a 400 will be returned
# Create user here
return 201, {}
Motivation
Why another framework ?
Two reasons:
- When using API Gateway + python lambdas, the pattern I often see is one unique lambda triggered by a proxy API Gateway resource. The lambda then uses Flask to do all the routing. In an API Gateway + Lambda context, I feel like the routing should be handled by API Gateway itself, then forwarding the request to specific lambda functions for each resource or endoint.
- The other reason is just fun.
N.B: I find it useful to declare the API Gateway -> Lambda routing using the amazing serverless framework
Next steps:
- Implement response validation
- Add tests
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pylambdarest-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 721a954f5289b2d629589c10d21f6a22ccdf3a29192b298bdf35c0db965bbec8 |
|
MD5 | 4e3c86eb0bb530a99d2ad55b368a1a2d |
|
BLAKE2b-256 | 7bcf0136d457a1361f3982f585795bed0085af27fd9c9a15c5082b6e109d824d |