notes-api

api for personal notes app

to run the app you have two ways manual or by having dockcer installed

if you have docker installed just run the following command

docker-compose up -d --build

antoher option is by having python installed run the following commands

pip install -r requirements.txt
python manage.py migrate
python manage.py runserver

after running the application you can go to the following url:

http://127.0.0.1:8000/

you will see the swagger page like this:

to use the api you need to register an account and get the key the authorize with it in the swagger page like the following screen:

then you can use the /notes end points:

GET /notes/ to get all pf your notes

POST /notes/ to create a new note

GET /notes/{id}/ retrieve specific note by id

DELETE /notes/{id}/ delete note by it's id

note: you can only access your user notes and delete them