The purpose of this project is to build an API with a reallife usecase and a boilerplate with
- FastAPI and PostgreSQL
- Auto pep8
- CI/CD pipeline
- documenting
clone the repo and install requirements by
pip install -r requirements.txt
To run the FastAPI
cd app
uvicorn main:app --reload
Default hostname is http://localhost:8000 and as it has inbuild documentation, http://localhost:8000/docs can be used to view/test the API's.
main.py is the main app which has API functionalities.
For deploying it on AWS lambda, create a repo in Github and add the aws secret,access and region in the secrets environment. Create S3 bucket and lambda function and API endpoint and configure the endpoint to created lambda function. edit the main.yml file and input it with your bucket name. This is a one time setup.
After completing the setup. Deploy it to the git repo. It creates a action pipeline which does the rest of the work.
This app is live on https://z3reusmmg9.execute-api.us-east-1.amazonaws.com/dev/docs
| Error Code | Description |
|---|---|
200 |
OK |
409 |
Conflict |
401 |
Un Authorized |
404 |
Not Found |
405 |
Method Not Allowed |
400 |
Bad Request |
The psycopg2 library which was installed doesnot work on aws lambda engine. reference >> jkehler/awslambda-psycopg2#47
I have downloaded the custom build and placed it in psycop2-fix folder. The pipeline automatically adds this build to the S3 bucket.