Task Management Application

Installation
API Documentation
SpringDoc(Swagger)

Installation

Склонируйте репозиторий с приложением:
```
git clone https://github.com/DmBalaev/task-management-application.git
```
Перейдите в каталог приложения:
```
cd task-management-application
```
Соберите проект:
```
mvn clean install -DskipTests=true
```
Опция -DskipTests=true в Maven используется для пропуска выполнения тестов во время сборки проекта.
Запустите docker контейнер:
```
docker-compose up -d
```
Флаг -d запускает контейнеры в фоновом режиме.

API Documentation

Authentication API

Аутентификация пользователя

URL: /api/v1/auth/signin

Method: POST

Request Body:

Type: AuthRequest

     {
        "email": "your_email",
        "password": "password"
      }

Responses:

200 OK: Аутентификация прошла успешно. Возвращает файл AuthResponse, содержащий данные аутентификации.
400 Bad Request: Указан неверный пароль.
422 Unprocessable Entity: Пользователь не существует.

Security:

Доступен всем пользователям

Зарегистрировать пользователя

URL: /api/v1/auth/signup

Method: POST

Request Body:

Type: RegistrationRequest

{
 "name": "your_name",
 "email": "your_email",
 "password": "password"
}

Responses:

200 OK: Регистрация прошла успешно. Возвращает объект AuthResponse, содержащий регистрационные данные.
400 Bad Request: Имя пользователя уже используется. Security

Security:

Доступен всем пользователям

Account Management API

Получение всех пользователей

URL: /api/v1/account

Method: GET

Responses:

200 OK: Возвращает коллекцию объектов AccountInfo, содержащих информацию о всех пользователях.
403 Forbidden: Нет необходимых прав доступа.

Получение пользователя по имени

URL: /api/v1/account/{username}

Method: GET

Responses:

200 OK: Возвращает объект AccountInfo, содержащий информацию о пользователе.
403 Forbidden: Нет необходимых прав доступа.
404 Not Found: Пользователь с указанным именем не существует. Security:

Требуется действительный токен JWT (BearerJWT) для аутентификации.

Comment Management API

Добавление комментария к задаче

URL: /api/v1/comment/add/{idTask}

Method: POST

Parameters:

idTask (Path Parameter): ID задачи, к которой добавляется комментарий.

Request Body:

Type: Comment

    {
    "text": "Текст комментария"
    }

Responses:

201 Created: Комментарий успешно добавлен. Возвращает объект Comment с добавленным комментарием.
404 Not Found: Задача не найдена.

Security:

Требуется действительный токен JWT (BearerJWT) для аутентификации.

Получение комментариев по задаче

URL: /api/v1/comment/task/{taskId}

Method: GET

Parameters:

taskId (Path Parameter): ID задачи, для которой запрашиваются комментарии.
page (Query Parameter, Optional): Номер страницы (с нуля) для получения комментариев.
size (Query Parameter, Optional): Количество элементов на странице.

Responses:

200 OK: Возвращает объект Page, содержащий комментарии для указанной задачи.
404 Not Found: Задача не найдена.

Security:

Требуется действительный токен JWT (BearerJWT) для аутентификации.

Task Management API

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

URL: /api/v1/task

Method: POST

Request Body:

Type: TaskRequest

  {
    "title": "Название задачи",
    "description": "Описание задачи"
  }

Responses:

201 Created: Задача успешно создана. Возвращает объект Task с созданной задачей.
401 Unauthorized: Пользователь не аутентифицирован.

Security:

Требуется действительный токен JWT (BearerJWT) для аутентификации.

Получение задачи по ID

URL: /api/v1/task/{id}

Method: GET

Parameters:

id (Path Parameter): ID задачи, которую нужно получить.

Responses:

200 OK: Задача успешно получена. Возвращает объект Task с задачей.
401 Unauthorized: Пользователь не аутентифицирован.
404 Not Found: Задача не найдена.

Security:

Требуется действительный токен JWT (BearerJWT) для аутентификации.

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

URL: /api/v1/task

Method: GET

Parameters:

page (Query Parameter, Optional): Номер страницы (с нуля) для получения задач.
size (Query Parameter, Optional): Количество элементов на странице.
status (Query Parameter, Optional): Фильтр по статусу задачи ('OPEN', 'IN_PROGRESS', 'RESOLVED', 'CLOSE').
priority (Query Parameter, Optional): Фильтр по приоритету задачи ('LOW', 'HIGH', 'MEDIUM').

Responses:

200 OK: Задачи успешно получены. Возвращает объект Page с задачами.
401 Unauthorized: Пользователь не аутентифицирован.

Security:

Требуется действительный токен JWT (BearerJWT) для аутентификации.

Обновление задачи

URL: /api/v1/task

Method: PUT

Request Body:

Type: TaskUpdateRequest

{
    "id": "id задачи",
    "title": "Название задачи",
    "description": "Описание задачи"
}

Responses:

200 OK: Задача успешно обновлена. Возвращает объект Task с обновленной задачей.
401 Unauthorized: Пользователь не аутентифицирован.
403 Forbidden: У пользователя нет необходимых разрешений.
404 Not Found: Задача не найдена.

Security:

Требуется действительный токен JWT (BearerJWT) для аутентификации.

Удаление задачи по ID

URL: /api/v1/task/{taskId}

Method: DELETE

Parameters:

taskId (Path Parameter): ID задачи для удаления. Responses:
204 No Content: Задача успешно удалена.
401 Unauthorized: Пользователь не аутентифицирован.
403 Forbidden: У пользователя нет необходимых разрешений.
404 Not Found: Задача не найдена.

Security:

Требуется действительный токен JWT (BearerJWT) для аутентификации.

Назначение задачи пользователю

URL: /api/v1/task/{taskId}/assign/{accountId}

Method: POST

Parameters:

taskId (Path Parameter): ID задачи для назначения.
accountId (Path Parameter): ID пользователя, которому назначается задача.

Responses:

200 OK: Задача успешно назначена. Возвращает объект Task с назначенной задачей.
401 Unauthorized: Пользователь не аутентифицирован.
403 Forbidden: У пользователя нет необходимых разрешений.
404 Not Found: Задача или пользователь не найдены.

Security:

Требуется действительный токен JWT (BearerJWT) для аутентификации.

Снятие задачи с пользователя

URL: /api/v1/task/{taskId}/unsign

Method: POST

Parameters:

taskId (Path Parameter): ID задачи для снятия с пользователя.

Responses:

204 No Content: Задача успешно снята с пользователя.
401 Unauthorized: Пользователь не аутентифицирован.
403 Forbidden: У пользователя нет необходимых разрешений.
404 Not Found: Задача не найдена или не назначена.

Security Требуется действительный токен JWT (BearerJWT) для аутентификации.

Изменение Статуса Задачи URL: /api/v1/task/{taskId}/change_status

Method: POST

Parameters:

taskId (Path Parameter): ID задачи для изменения статуса.

Request Body:

{
  "taskStatus": "IN_PROGRESS"
}

Responses:

204 No Content: Статус задачи успешно изменен.
400 Bad Request: Указан неверный статус задачи.
401 Unauthorized: Пользователь не аутентифицирован.
403 Forbidden: У пользователя нет необходимых разрешений.
404 Not Found: Задача не найдена.

Security:

Требуется действительный токен JWT (BearerJWT) для аутентификации.

Изменение Приоритета Задачи

URL: /api/v1/task/{taskId}/change_priority

Method: POST

Parameters:

taskId (Path Parameter): ID задачи для изменения приоритета.

Request Body:

Type: JsonNode
```
{
  "taskPriority": "MEDIUM"
}
```

Responses:

204 No Content: Приоритет задачи успешно изменен.
400 Bad Request: Указан неверный приоритет задачи.
401 Unauthorized: Пользователь не аутентифицирован.
403 Forbidden: У пользователя нет необходимых разрешений.
404 Not Found: Задача не найдена.

Security:

Требуется действительный токен JWT (BearerJWT) для аутентификации.

Задачи По Автору

URL: /api/v1/task/author/{accountId}

Method: GET

Parameters:

accountId (Path Parameter): ID автора для получения задач.

Responses:

200 OK: Задачи автора успешно получены. Возвращает объект Page с задачами.
401 Unauthorized: Пользователь не аутентифицирован.
403 Forbidden: У пользователя нет необходимых разрешений.
404 Not Found: Автор не найден.

Security:

Требуется действительный токен JWT (BearerJWT) для аутентификации.

Задачи По Исполнителю

URL: /api/v1/task/assignee/{accountId}

Method: GET

Parameters:

accountId (Path Parameter): ID исполнителя для получения задач.

Responses:

200 OK: Задачи исполнителя успешно получены. Возвращает объект Page с задачами.
401 Unauthorized: Пользователь не аутентифицирован.
403 Forbidden: У пользователя нет необходимых разрешений.
404 Not Found: Исполнитель не найден.

Security:

Требуется действительный токен JWT (BearerJWT) для аутентификации.

Open API (Swagger).

После запуска приложения будет доступен UI

Swagger UI: http://localhost:8080/swagger-ui/index.html

dmbalaev / task-management-application Goto Github PK