A simple Bank API built as part of a coding interview using Python, Flask and SQLite
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
- Install Python 3.6+ and git.
A step by step series of examples that tell you how to get a development env running
Clone the repo
git clone https://github.com/robinstauntoncollins/bank-api.git
cd bank-apiCreate virtual environment
python -m venv venv/Activate virtual environment
On Linux
source venv/bin/activateOn Windows
source venv/Scripts/activateInstall dependencies
pip install -r requirements.txtInitialize database
flask db upgradeRun tests
pytestStart server
Windows
python bankapi.pyLinux
./bankapi.pyI like HTTPie CLI but curl works too.
List of available endpoints
>> http GET http://localhost:5000/
HTTP/1.0 200 OK
Content-Length: 521
Content-Type: application/json
Date: Tue, 21 Apr 2020 21:17:57 GMT
Server: Werkzeug/1.0.1 Python/3.7.0
{
"version": {
"v1": {
"actions": {
"get_customer_url": "http://localhost:5000/api/v1/getCustomerInfo",
"open_account_url": "http://localhost:5000/api/v1/openAccount",
"transfer_url": "http://localhost:5000/api/v1/transfer"
},
"collections": {
"accounts_url": "http://localhost:5000/api/v1/accounts",
"customers_url": "http://localhost:5000/api/v1/customers",
"transactions_url": "http://localhost:5000/api/v1/transactions"
}
}
}
}Make new customer
>> http POST http://localhost:5000/api/v1/customers name="Monty" surname="Python"
HTTP/1.0 201 CREATED
Content-Length: 119
Content-Type: application/json
Date: Tue, 21 Apr 2020 21:24:42 GMT
Server: Werkzeug/1.0.1 Python/3.7.0
{
"customer": {
"name": "Monty",
"surname": "Python",
"uri": "/api/v1/customers/1"
}
}Open new account for the newly created customer
>> http POST http://localhost:5000/api/v1/openAccount customerID=1 initialCredit=500
HTTP/1.0 200 OK
Content-Length: 170
Content-Type: application/json
Date: Tue, 21 Apr 2020 21:26:25 GMT
Server: Werkzeug/1.0.1 Python/3.7.0
{
"account": {
"account_number": 11210932237993115648,
"balance": 500.0,
"customer_id": 1,
"uri": "/api/v1/getCustomerInfo"
},
"result": true
}View all customer information: accounts, transactions
λ http GET http://localhost:5000/api/v1/getCustomerInfo customerID=1
HTTP/1.0 200 OK
Content-Length: 1071
Content-Type: application/json
Date: Tue, 21 Apr 2020 21:28:06 GMT
Server: Werkzeug/1.0.1 Python/3.7.0
{
"customer": {
"accounts": [
{
"account_number": 11210932237993115648,
"balance": 500.0,
"customer_id": 1,
"transactions": [
{
"account_id": 1,
"amount": 500.0,
"time": "2020-04-20T19:37:22.160495"
}
]
}
],
"name": "Monty",
"surname": "Python"
}
}Initialize database with preloaded data (Optional)
flask createdbRun with coverage report:
pytest --cov=bank_api tests/Build image
docker build -t bankapi:latest .Start container
docker run --name bankapi -d -p 5000:5000 --rm bankapi:latest- Flask - The web framework used
- FlaskRESTful - Flask extension for building REST APIs
- FlaskSQLALchemy - Flask extension which adds support for the SQLAlchemy ORM
- FlaskMigrate - Flask extension which adds support for database migrations using Alembic
This project is licensed under The Unlicense - see the LICENSE.md file for details