Categorygithub.com/Antoha2/news
module
0.0.0-20240225100052-ba198c1b5abd
Repository: https://github.com/antoha2/news.git
Documentation: pkg.go.dev

# README

Проект запускается в терминале командой "docker-compose up"

Сервер слушает 80 порт локалхоста .

http://127.0.0.1:80/auth/register - регистрация пользователя . Указывается EMAIL и PASSWORD в теле POST-запроса в формате JSON.

http://127.0.0.1:80/auth/login - аутентификация пользователя . Указывается EMAIL и PASSWORD в теле POST-запроса в формате JSON.

RegisterNewUser - добавление нового пользователя в базу данных(БД) . Получает значения "EMAIL", "PASSWORD" в теле POST-запроса в формате JSON , добавляет в базу данных нового пользователя со всеми полученныими параметрами, присваивая уникальный ID . Возвращает ID добавленного пользователя в формате JSON.

Login - аутентификация пользователя . Получает значения "EMAIL", "PASSWORD" в теле POST-запроса в формате JSON , возвращает уникальный токен , по которому будет предоставлен доступ для сервиса новостей.

http://127.0.0.1:80/news - получить новости. в теле GET-запроса можно указать LIMIT и OFFSET в формате JSON для пагинации вывода.

http://127.0.0.1:80/news/:id - редактирование новости с указанным в URL ID. в теле PUT-запроса указываются параметры новости в формате JSON. ID менять нельзя (нарушается целостность) . Реализвать эту механику можно , но не нужно .

http://127.0.0.1:80/news - добавить новость. В теле POST-запроса параметры указываются в формате JSON.

addNews - добавление новой новости в базу данных(БД) . Получает значения "title", "content", "categories[]" в теле POST-запроса в формате JSON , добавляет в базу данных новую новость со всеми полученныими параметрами, присваивая уникальный ID это записи. Возвращает ID добавленной новости в формате JSON. Искуственные ограничения ввода: title < 255 символов, content < 1000 символов, *categories[] < 10.

getNews - чтение всех новостей из БД . Получает GET-запрос . Возвращает данные все новости в формате JSON.

editNews - изменение данных пользователя по ID из БД . Получает значение ID из URL PUT-запроса , новые значения (и/или) " title", "content", "categories[]" должны быть перечисленны в теле запроса в формате JSON . Возвращает данные измененной новости в формате JSON. Если значение новое значение не будет указано , то соответствующее значение в БД не будет изменено. Искуственные ограничения ввода: title < 255 символов, content < 1000 символов, *categories[] < 10.

# Packages

No description provided by the author
No description provided by the author