ikushaldave / basic-todo-api

This is simple basic todo api can be used to GET, POST, UPDATE, DELETE a todo.

Basic Todo API

This is simple basic todo api can be used to GET, POST, UPDATE, DELETE a todo.

To make the POST, DELETE and PUT operation you can use the following snippet. Changing the method to specific type of request.

fetch(url, {
    method: 'POST', // *GET, POST, PUT, DELETE, etc.
    headers: {
      'Content-Type': 'application/json'
    },
    body: JSON.stringify(data) // body data type must match "Content-Type" header
  });

Note - Don't pollute the API by posting some test data (like testingggg etc).

BASE URL = https://basic-todo-api.vercel.app/api/todo

Endpoints

1. GET /api/todo

To get all todo list

return todos

2. POST /api/todo

The request body should be in following format (isCompleted default to false if you want to true add isCompleted to true)

{
  "todo": {
    "title": "abc",
    "isCompleted": true
  }
}

return todos

Note - title should be minimum of length 2 and is required

3. PUT /api/todo/:id

To update a todo it required a id of todo you want to update

e.g - /api/todo/60360d088c1327d639a525d1

and take similar format as post todo which you want to update

{
  "todo": {
    "title": "qwerty"
  }
}

return todos

4. DELETE /api/todo/:id

To delete a todo it required a id of todo you want to delete

e.g - /api/todo/60360d088c1327d639a525d1

return todos

Response

The following response(object containing available todo with total todo) will return on above method:

{
  "todos": [
    {
      "isCompleted": false,
      "_id": "6036099201c9a39658f33787",
      "title": "Learn Node",
      "createdAt": "2021-02-24T08:08:50.687Z",
      "updatedAt": "2021-02-24T08:08:50.687Z",
      "__v": 0
    },
    {
      "isCompleted": false,
      "_id": "60360d088c1327d639a525d1",
      "title": "Learn Express",
      "createdAt": "2021-02-24T08:23:36.465Z",
      "updatedAt": "2021-02-24T08:25:09.868Z",
      "__v": 0
    }
  ],
  "noOfTodos": 2
}