Skip to content

MariaFantasy/java-plus-graduation

Repository files navigation

java-explore-with-me-plus

Template repository for ExploreWithMe project.


Комментарии

Комментарии реализованы на примере TripAdvisor.

erDiagram
    comments {
        bigint id PK
        bigint event_id FK
        bigint author_id FK
        bigint reply_on_id FK "Nullable"
        string(2000) text
        datetime created_on
        datetime updated_on "Nullable"
    }
Loading

Доступные эндпоинты


Public


GET /events/{eventId}/comments - Просмотр комментариев на событии
  • Событие должно быть опубликовано
  • Сортировка по убвыванию даты создания сообщения
Параметры:
  • eventId - Id события, к которому нужно вернуть комментарии
  • from - Количество коментариев, которые нужно пропустить для форматирования текущего набора. Default value: 0
  • size - Количество коментариев в наборе. Default value: 10
Статусы ответов:
Описание Код ответа Тело ответа
Запрос обработан успешно 200 OK Collection
Запрос составлен некорректно 400 Bad Request ApiError
Событие не найдено 404 Not Found ApiError

Private


GET /users/{userId}/comments - Просмотр всех комментариев пользователя
  • Сортировка по убвыванию даты создания сообщения
Параметры:
  • userId - Id клиента, чьи комментарии нужно вернуть
  • from - Количество коментариев, которые нужно пропустить для форматирования текущего набора. Default value: 0
  • size - Количество коментариев в наборе. Default value: 10
Статусы ответов:
Описание Код ответа Тело ответа
Запрос обработан успешно 200 OK CommentDto
Запрос составлен некорректно 400 Bad Request ApiError
Клиент не найден 404 Not Found ApiError
POST /users/{userId}/comments - Добавление комментария к событию
Параметры:
  • userId - Id клиента, который создает комментарий
Тело запроса:

NewCommentDto

event Id события, к которому создается комментарий Обязательный параметр
replyOn Id комментария, на который дается ответ Необязательный параметр
text Текст комментария Обязательный параметр
Статусы ответов:
Описание Код ответа Тело ответа
Запрос обработан успешно 201 CREATED CommentDto
Запрос составлен некорректно 400 Bad Request ApiError
Комментарий или пользователь не найден 404 Not Found ApiError
PATCH /users/{userId}/comments/{commentId} - Обновление комментария
Параметры:
  • userId - Id клиента, который создает комментарий
  • commentId - Id комментария, к которому нужно оставить комментарии
Тело запроса:

UpdateCommentDto

text Текст комментария Обязательный параметр
Статусы ответов:
Описание Код ответа Тело ответа
Запрос обработан успешно 200 OK CommentDto
Запрос составлен некорректно 400 Bad Request ApiError
Комментарий или пользователь не найден 404 Not Found ApiError
DELETE /users/{userId}/comments/{commentId} - Удаление комментария
  • Удалить комментарий может только автор
Параметры:
  • commentId - Id комментария, к которому нужно оставить комментарии
Статусы ответов:
Описание Код ответа Тело ответа
Запрос обработан успешно 204 NO_CONTENT
Запрос составлен некорректно 400 Bad Request ApiError
Комментарий или пользователь не найден 404 Not Found ApiError

Admin


DELETE /admin/comments/{commentId} - Удаление комментария
Параметры:
  • commentId - Id комментария, к которому нужно оставить комментарии
Статусы ответов:
Описание Код ответа Тело ответа
Запрос обработан успешно 204 NO_CONTENT
Комментарий не найден 404 Not Found ApiError

About

Template repository for Graduation project.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors