Coded by Novak Zaballa
The scope of this project is login and operations backend fro a payed calculator.
This project has been built with Serverless Framework and targeting AWS lambda with Python 3.8 + DynamoDB + Aurora PostgreSQL. You can deploy the project to AWS installing and configuring serverless, or you can run the services locally, using the serverless-offline plugin, which is included. The offline configuration also includes a local DynamoDB instance is provided by the serverless-dynamodb-local plugin.
Authorization for testing Every request must include an authorization header containing the OAuth Bearer token. For testing purposes currently an account is in seed in the DB. The request content type must be application/json as per the examples below. While in dev stage, I will provide valid access credentials for a test user through a secure channel.
You can test locally following the former instructions, however there is also a live test with the following endpoints published in my AWS account for testing purposes:
Available endpoints:
GET - https://68i17san2e.execute-api.us-east-1.amazonaws.com/dev/api/v1/operations
POST - https://68i17san2e.execute-api.us-east-1.amazonaws.com/dev/api/v1/operations
POST - https://68i17san2e.execute-api.us-east-1.amazonaws.com/dev/api/v1/auth
PUT - https://68i17san2e.execute-api.us-east-1.amazonaws.com/dev/api/v1/operations/{operation_record_id}
Click here to see API documentation and test iit n Swagger UI
You can use the following usernames: novak, jane, john. They have an initial credit balance of 100, 500, and 30, correspondingly.
Prequisites: Python >= 3.8 PIP
Follow the steps below in the root directory of the project. Use the command line in the root directory of the project and execute:
pip install -r requirements
pytest
Run service offline To test the project locally use:
sls simulate apigateway
You will need to configure authentication key in a .env file in the root folder containing:
JWT_SECRET_KEY=YOUR_SECRET_KEY_VALUE
To deploy the service you need an account in AWS. Use the following command:
serverless deploy -v
Authorization for testing Every request must include an authorization header containing the OAuth Bearer token. For testing purposes currently an account is in seed in the DB. The request content type must be application/json as per the examples below. While in dev stage, I will provide valid access credentials for a test user through a secure channel.
You can test locally following the former instructions, however there is also a live test with the following endpoints published in my AWS account for testing purposes:
Available endpoints:
- GET - https://68i17san2e.execute-api.us-east-1.amazonaws.com/dev/api/v1/operations
- POST - https://68i17san2e.execute-api.us-east-1.amazonaws.com/dev/api/v1/operations
- POST - https://68i17san2e.execute-api.us-east-1.amazonaws.com/dev/api/v1/auth
- PUT - https://68i17san2e.execute-api.us-east-1.amazonaws.com/dev/api/v1/operations/{operation_record_id}
Click here to see API documentation and test it in Swagger UI
You can use the following usernames: novak, jane,and john. They have an initial credit balance of 100, 500, and 30, correspondingly. The username john is used by Cypress automated tests, so its operations records are cleaned before and after running the cypress tests automatically as part of the tests.
The password for the test users has been sent in an email.