Viacheslav-Filipenko / server-todo

Todo server

• Get todos
• Get todo
• Update todo
• Delete todo

Get todos

Retrieve all todos.

URI

https://todo-training.herokuapp.com/todos

HTTP Method

GET

Required Parameters

(none)

Sample Request

https://todo-training.herokuapp.com/todos

Sample Response

json
{
    "data": [
        {
           "id": 1,
            "description": "todo",
            "completed": false,
            "dueDate": null
            "updatedAt": "2019-08-13T11:53:05.551Z",
            "createdAt": "2019-08-13T11:53:05.551Z"
        },
        {
            "id": 2,
            "description": "todo",
            "completed": false,
            "dueDate": null
            "updatedAt": "2019-08-13T11:53:05.551Z",
            "createdAt": "2019-08-13T11:53:05.551Z"
        }
    ]
}

Get todo

Retrieve one todo.

URI

https://todo-training.herokuapp.com/todos/{id}

HTTP Method

GET

Required Parameters

Field	Type	Description
id	[int]	The id of todo to get

Sample Request

https://todo-training.herokuapp.com/todos/1

Sample Response

json
{
    "data": {
        "id": 1,
        "description": "todo",
        "completed": false,
        "dueDate": null
        "updatedAt": "2019-08-13T11:53:05.551Z",
        "createdAt": "2019-08-13T11:53:05.551Z"
    }
}

Add todo

Add todo to the todo list.

URI

https://todo-training.herokuapp.com/todos

HTTP Method

POST

Required Parameters

Field	Type	Description
description	[string]	the description of todo

Optional Parameters

Field	Type	Description
dueDate	[date]	the due date for todo
endDate	[date]	the end date for todo

Sample Request

https://todo-training.herokuapp.com/todos

json
{
	"description": "todo"
}

Sample Response

json
{
    "data": {
        "id": 1,
        "description": "todo",
        "completed": false,
        "dueDate": null,
        "updatedAt": "2019-08-13T11:53:05.551Z",
        "createdAt": "2019-08-13T11:53:05.551Z"
    }
}

Update todo

URI

https://todo-training.herokuapp.com/todos/{id}

HTTP Method

PUT

Required Parameters

Field	Type	Description
id	[int]	The id of todo to update
description	[string]	the description of todo
completed	[bool]	state of todo

Optional Parameters

Field	Type	Description
dueDate	[date]	the due date for todo
endDate	[date]	the end date for todo

Sample Request

https://todo-training.herokuapp.com/todos/1

json
{
    "description": "todo",
    "completed": true
}

Sample Response

json
{
    "data": {
        "id": 2,
        "description": "todo",
        "completed": true,
        "dueDate": null,
        "updatedAt": "2019-08-13T11:53:05.551Z",
        "createdAt": "2019-08-13T11:53:05.551Z"
    }
}

Delete todo

URI

https://todo-training.herokuapp.com/todos/{id}

HTTP Method

DELETE

Required Parameters

Field	Type	Description
id	[int]	The id of todo to delete

Sample Request

https://todo-training.herokuapp.com/todos/1

Sample Response

json
{
}