README.md

SimpleTodo

SimpleTodo is simple Node.js REST API for Todo interview task.

Simple usage

Just run (while in server directory)

docker-compose up

The server will listen on localhost port 3000.

Optional: add N sample ToDo items:

docker-compose run todo npm run fixtures:todo --todo-count=N

API documentation

Get all todos

~|⇒  http -pb :3000/api/v1/todo/
{
    "items": [],
    "meta": {
        "hasNextPage": false,
        "hasPrevPage": false,
        "itemCount": 0,
        "limit": 20,
        "nextPage": null,
        "offset": 0,
        "page": 1,
        "pageCount": 1,
        "prevPage": null
    }
}

Where

items: the array of objects

hasNextPage: availability of next page

hasPrevPage: availability of prev page

itemCount: total number of objects in the collection

limit: limit of objects per page

nextPage: next page number if available or null

offset: offset

page: current page number

pageCount: total number of pages

prevPage: previous page number if available or null

This method also accepts filters in the form of query parameters description and done.

Pagination

Using query parameters limit (20 by default) and offset (along with other fields like hasNextPage and others described above) one can implement pagination.

Create new todo

~|⇒  http -pb POST :3000/api/v1/todo/ description='First todo'
{
    "_id": "5fa2f26d7222f300103400da",
    "createdAt": "2020-11-05T07:52:21.235Z",
    "description": "First todo",
    "done": false,
    "updatedAt": "2020-11-05T07:52:21.235Z"
}

Change a todo

~|⇒  http -pb PUT :3000/api/v1/todo/5fa2f26d7222f300103400da done:=true
{
    "_id": "5fa2f26d7222f300103400da",
    "createdAt": "2020-11-05T07:52:21.235Z",
    "description": "First todo",
    "done": true,
    "updatedAt": "2020-11-05T07:53:26.388Z"
}

Delete a todo

~|⇒  http DELETE :3000/api/v1/todo/5fa2f26d7222f300103400da
HTTP/1.1 204 No Content