This API uses a Swagger client to access bpdts-app API. This solution uses Flask to expose an API which has a single endpoint. When called this single endpoint will return a list of users who are living in London or whose coordinates are within 50 miles of London. This API has been written in python (3.8.2)
This solution has been deployed as a Heroku app. Click here to visit the Heroku app.
- flask
- flask-restplus
- geopy
- gunicorn
- mock
- requests
- werkzeug
To get the software for LondonUsers, please run the following
git clone https://github.com/ColinBeeby-Developer/LondonUsers
Now run the script to set up the required packages
cd LondonUsers
./setup.sh
gunicorn londonersapi:app
To view the Swagger documentation, browse to this location
http://127.0.0.1:8000
To call the API
curl -X GET http://localhost:8000/users/london
To run the automated unit tests which are included with this solution, in the dwp-test folder run the following commands.
python3 -m unittest discover -k unit_test -v
To run the automated integration tests which are included with this solution, in the dwp-test folder run the following commands.
On one instance of the command line
gunicorn londonersapi:app
On another instance of the command line
python3 -m unittest discover -k integration_test -v