Skip to content
Илья Седов edited this page Jul 19, 2015 · 2 revisions

Welcome to the ToDo-server wiki!

Supported methods:

GET /items - возвращает список TODO-тасков без сортировки. Пример вывода:

{
  "results": [
    {
      "completed": 0, 
      "completion_date": null, 
      "creation_date": 1437314216, 
      "item_id": 1, 
      "title": "adsfasdf"
    }
}

POST /item - создает новый элемент. Возвращает новый объект или ошибку HTTP 400, если не хвататет параметров. Параметры: title - название таска. Обязательный параметр. Возвращает только что созданный объект:

{
  "completed": 0, 
  "completion_date": null, 
  "creation_date": 1437316090, 
  "item_id": 4, 
  "title": "new item"
}

GET /item/:id - возвращает таск с заданным id. Возвращает такой JSON:

{
  "completed": 0, 
  "completion_date": null, 
  "creation_date": 1437316090, 
  "item_id": 4, 
  "title": "new item"
}

POST /item/:id - редактирует таск с заданным id. Можно задавать любые параметры. Пример:

curl -d "completed=1" http://localhost:5000/item/4
{
  "completed": 1, 
  "completion_date": null, 
  "creation_date": 1437316090, 
  "item_id": 4, 
  "title": "new item"
}

DELETE /item/:id - удаляет элемент с заданным id. В случае успешного удаления возвращает такой JSON:

{
  "results": "Item removed"
}

В случае большинства ошибок возвращается JSON и HTTP код 40X:

HTTP/1.0 404 NOT FOUND
{
  "error": "No item with id=5"
}

Для неподдерживаемых методов в endpoint'е возвращает стандартная Flask страницы и код 400. В некоторых случаях может падать сервер. При перезапуске сервера старая база удаляется!

Clone this wiki locally