Skip to content

Pratik-sys/TodoAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

70 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TODO API

Technologies


  • Flask
  • Flask Rest-x
  • Flask Mongoengine
  • Flask-Jwt-Extended

Run your code in local development enviroment


  • Clone the project into your local machine

    $ git clone https://github.com/Pratik-sys/TodoAPI
  • To run this project, install requiremnts.txt

    $ pip install -r requirements.txt
  • Run the main file to get the server runing on your local machine

    $ python run.py
  • you can test the Api in Postman for better visualization

list of endpoints

if you are running the server on localhost the prefix to all the endpoints will be http://127.0.0.1:5000/


User Endpoints

api/users/register
api/users/login

Todo Endpoints

api/todos/getAll
api/todos/add
api/todos/<todo_id>update
api/todos/<todo_id>/delete

Subtask Endppoints

api/subtasks/<todo_id>getAll
api/subtasks/<todo_id>/add
api/subtasks/<subtask_id>/update
api/subtasks/<subtask_id>/delete

Note :- The swagger is been disabled intentionally, you can test the API on Postman