This provides an specification file for the Swapin Api
Description and use of the API - Swap.in - Final project Platzi Master program
You need install and use:
Python3
pip3
Install the requirements and execute the env and install the requirements. for macOS:
python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements.txt
for windows
python3 -m venv venv
venv\Scripts\activate.bat
pip3 install -r requirements.txt
Local execution
python3 manage.py migrate
python3 manage.py runserver
CD automatic with Heroku: https://swapin.herokuapp.com/
| ENDPOINT | DESCRIPTION |
|---|---|
| home/ | endpoint for random clothes to show on feed app |
| users/signup/ | send information to signup a new user |
| users/login/ | use the credentials for the user to login on the app |
| users/verify/ | an endpoint where redirect to login when the user clic on it in his email |
| users/list_clothes/int:id/ | endpoint to see all the clothes by an specific user |
| clothes/like/ | that is responsible for creating the like, the notification and return whether or not it was a match |
| clothes/notification_user/int:id/ | that is responsible for obtaining notifications by user, when it is a match it returns true or false, if it is true it returns the phone number to be able to teach the match |
| clothes/notification_clothe/int:id/ | that is responsible for bringing the list of notifications for clothing |
| clothes/notification_read/ | that is responsible for saving the notification is read |
| clothes/get_categories/ | that is responsible for returning the list of clothing categories |
| clothes/search_clothes/int:id_category/int:id_user/ | that is responsible for returning the result of the clothes by category |
This project it's under the license (MIT) - look at file LICENSE.md for details