fridges-api/README.md

fridges-api

Try this server using Binder! »

Fridges API

A REST API of fridges with various foods like fruits built with Flask using Python.

Built from the Backend (Rest APIs and FLASK) Workshop by @lucentfong for @HackRU.

File Details

• api.py - Flask API server, can be ran with command flask run.
• api_test.py - Various HTTP requests using the requests module to test the local flask server endpoints. You can also instead use Postman or Thunder Client on VSCode.
• requirements.txt - can be used with command pip install -r requirements.txt to install all virtual environment dependencies (run this command after activating your virtual environment). You can instead solely install flask for the server.

Dependencies to Install

For the Flask server:

• flask

For the API testing script:

• requests

Acknowledgements/Credits

• @lucentfong
• @HackRU