This is a simple API built for the sole purpose of finding a lasting solution to the myriads of a accomodation issues in O.O.U Ago-iwoye environs. Students don't find it easy in their search for apartment. It was for that purpose, that was why this API was built.
Modern Python web technologies were adopted for this project
Django: Django is a Python-based free and open-source web framework, which follows the model-template-view architectural pattern. It is maintained by the Django Software Foundation, an independent organization established as a 501 non-profit. Visit here for more information.
Django-Rest-Framework: Django REST framework is a powerful and flexible toolkit for building Web APIs. Visit here for more information.
git clone https://github.com/samson1998/Findr-API.git
cd Findr-API
pip install -r requirements.txt
python manage.py migrate
python manage.py runserver
python mange.py createsuperuser
| HTTP VERB | ENDPOINT | FUNCTIONALITY |
|---|---|---|
| POST | /api/v1/users | Creates a user |
| POST | /api/v1/login | Login a user |
| POST | /api/v1/users | Creates a user |
| PATCH | /api/v1/users | Update a user |
| POST | /api/v1/apartments | Create an apartment |
| POST | /api/v1/apartments | Get list of all apartments |
| GET | /api/v1/users | View all users |
| GET | /api/v1/users/{id} | View a particular user |
| GET | /api/v1/apartments/{id} | View a particular apartment |
| PATCH | /api/v1/users | Update a user |
| DELETE | /api/v1/apartments/{id} | Delete a particular apartment |