This REST API contains some basic routes for adding, removing, and viewing stored zip codes. This is meant to demonstrate ability for an interview challenge.
To run the API you will need to have both Python3.8 and the Flask module installed. As this is a very basic flask API you can follow the run instructions below here or see the docs for help with your specific system.
After cloning the repo and installing all prerequisites simply run:
$ export FLASK_APP=ss_challenge
$ flask run
This will start the API locally on port 5000.
NOTE: If you do not install the flask CLI you may need to use
python -m flask runinstead.
The following routes ara exposed from the API:
POST /insert/:zip_code - Inserts specified Zip Code to memory
DELETE /delete/:zip_code - Deletes specified Zip Code from memory
GET /has/:zip_code - Checks specified Zip Code in memory
GET /display - Returns stored Zip Codes from memory
NOTE: A Postman collection for the API has been provided as a convenvience in the collection.json file. It also contains examples for the routes (shows basic error handling).