This repository contains Flask API endpoints and tests for the Hello-World Application.
Clone Repo From GitHub
git clone https://github.com/brandeddavid/Hello-Books-Flask-API.git
Enter Directory
cd Hello-Books-Flask-API
Create Virtual Environment
virtualenv -p python3 venv
Start virtualenv
source venv/bin/activate
Install Dependencies
pip install -r requrements.txt
Run app
python run.py
| Endpoint | Description |
|---|---|
| POST /api/v1/books | Adds a New Book |
| PUT /api/v1/books/string:bookId | Edits Individal Book Info |
| DELETE /api/v1/books/string:bookId | Deletes A Book |
| GET /api/v1/books | Retrieves All Books |
| GET /api/v1/books/<string: bookId> | Get Book by id |
| POST /api/v1/users/books/<string: bookId> | Borrow a book |
| POST /api/v1/auth/register | Register a New User |
| POST /api/v1/users | Gets all Users |
| POST /api/v1/auth/login | Logs in a registered User |
| POST /api/v1/auth/logout | Logs Out a Logged in |
Find API endpoints documentation here
Use Postman and the provided documentation to test the API endpoints
David Mwangi Mathenge