Task manager API

Инструкция по установке и запуску API в Docker

1. Клонировать проект с GitHub и перейти в дерикторию проекта

   git clone https://github.com/GuVictory/TaskManager.git
   cd TaskManager

2. Выдать права .sh скрипту из дериктории проекта

   chmod +x ./entrypoint.sh

3. Сборка и запуск Docker контейнера

   docker-compose -f docker-compose.prod.yml up -d --build

   Далее сервис будет доступен по http://localhost:8000/api/

Документация к API

Работа с пользвателем

Регистрация:

• Url: /users/
• Method: POST
• Request body:

{
  "username": "username",
  "password": "password"
}

• Response status 201 and body:

{
  "id": "id",
  "username": "username"
}

• Response status 400 and body:

{
  "username":["A user with that username already exists."]
}

---

Авторизация

• Url: /login/
• Method: POST
• Request body:

{
  "username": "username",
  "password": "password"
}

• Response status 200 and body:

{
  "token": "hello_token_example"
}

• Response status 400 and body:

{
  "non_field_errors":["Unable to log in with provided credentials."]
}

Работа с задачами

Создание задачи

• Url: /tasks/
• Method: POST
• В Headers необходима авторизация через Authorization
• Request body (finish_date может не быть):

{
  "title": "title",
  "description": "description",
  "status": "status",
  "finish_date": "finish_date"
}

• Response status 201 and body:

{
  "id": "id_of_task",
  "title": "title",
  "description": "description",
  "status": "status",
  "finish_date": "finish_date"
}

---

Получение списка всех задач

• Url: /tasks/
• Method: GET
• В Headers необходима авторизация через Authorization
• Возвращает только задачи авторизованного пользователя
• Response status 200 and body:

[
  {
      "id": "id_of_task1",
      "title": "title1",
      "description": "description1",
      "status": "status1",
      "finish_date": "finish_date1"
  },
  {
      "id": "id_of_task2",
      "title": "title2",
      "description": "description2",
      "status": "status2",
      "finish_date": "finish_date2"
  }
]

---

Получение конкретной задачи пользователя по id

• Url: /tasks/int:id/
• Method: GET
• В Headers необходима авторизация через Authorization
• Возвращает только задачи авторизованного пользователя, если задача с таким id не принадлежит авторизованному пользователю => вернется 404
• Response status 200 and body:

{
      "id": "id",
      "title": "title",
      "description": "description",
      "status": "status",
      "finish_date": "finish_date"
  }

• Response status 404 and body:

{
      "message": "User don't have task with that id"
}

---

Изменение конкретной задачи пользователя по id

• Url: /tasks/int:id/
• Method: POST/PUT
• В Headers необходима авторизация через Authorization
• Работает только с задачами авторизованного пользователя, если задача с таким id не принадлежит авторизованному пользователю => вернется 404
• Request body (можно отправлять как одно из полей, так и несколько):

{
  "title": "new_title"
}

{
  "title": "new_title",
  "status": "new_status"
}

{
  "title": "new_title",
  "description": "new_description",
  "status": "new_status",
  "finish_date": "new_finish_date"
}

• Response status 200 and body:

{
      "id": "id",
      "title": "title",
      "description": "description",
      "status": "status",
      "finish_date": "finish_date"
  }

• Response status 400 and body (в случае указания статуса, не входящих в стандарные значения):

{
      "message": "Status is not correct!"
}

• Response status 400 and body (в случае указания даты завершения задачи в некорректном формате (не YYYY-MM-DD)):

{
      "message": "Date format is not correct use YYYY-MM-DD"
}

• Response status 404 and body:

{
      "message": "User don't have task with that id"
}

---

Работа с задачами

Получение списка всех задач со статусом "Новая"

• Url: /new_tasks/
• Method: GET
• В Headers необходима авторизация через Authorization
• Возвращает только задачи авторизованного пользователя
• Response status 200 and body:

[
  {
      "id": "id_of_task",
      "title": "title",
      "description": "description",
      "status": "New",
      "finish_date": "finish_date"
  }
]

---

Получение списка всех задач со статусом "Запланированная"

• Url: /planned_tasks/
• Method: GET
• В Headers необходима авторизация через Authorization
• Возвращает только задачи авторизованного пользователя
• Response status 200 and body:

[
  {
      "id": "id_of_task",
      "title": "title",
      "description": "description",
      "status": "Planned",
      "finish_date": "finish_date"
  }
]

---

Получение списка всех задач со статусом "в Работе"

• Url: /planned_tasks/
• Method: GET
• В Headers необходима авторизация через Authorization
• Возвращает только задачи авторизованного пользователя
• Response status 200 and body:

[
  {
      "id": "id_of_task",
      "title": "title",
      "description": "description",
      "status": "in Work",
      "finish_date": "finish_date"
  }
]

---

Получение списка всех задач со статусом "Завершённая"

• Url: /planned_tasks/
• Method: GET
• В Headers необходима авторизация через Authorization
• Возвращает только задачи авторизованного пользователя
• Response status 200 and body:

[
  {
      "id": "id_of_task",
      "title": "title",
      "description": "description",
      "status": "Compleated",
      "finish_date": "finish_date"
  }
]

---

Получение списка всех задач отсортированных по возрастанию даты завершения

• Url: /sort_by_date_tasks/
• Method: GET
• В Headers необходима авторизация через Authorization
• Возвращает только задачи авторизованного пользователя
• Response status 200 and body:

[
  {
      "id": "id_of_task",
      "title": "title",
      "description": "description",
      "status": "status",
      "finish_date": "finish_date"
  }
]

---

Получение списка всех задач отсортированных по убаванию даты завершения

• Url: /sort_by_date_desc_tasks/
• Method: GET
• В Headers необходима авторизация через Authorization
• Возвращает только задачи авторизованного пользователя
• Response status 200 and body:

[
  {
      "id": "id_of_task",
      "title": "title",
      "description": "description",
      "status": "status",
      "finish_date": "finish_date"
  }
]

---

Получение истории изменения задачи

• Url: /int:id/task_history/
• Method: GET
• В Headers необходима авторизация через Authorization
• Возвращает только задачи авторизованного пользователя
• Response status 200 and body:

[
  {
    "id": "id",
    "task": "task",
    "note": "note",
    "time_of_edit": "time_of_edit"
  }
]