news-aggregator API

Бэкенд сервиса news-aggregator, на котором можно найти новости по запросу и сохранить в личном кабинете. Разработан в среде NodeJS, на фреймворке express.

Публичный IP сервера: 84.201.181.220

Домен: https://api.news-aggregator.tk

v1.0

Инструкция по развёртыванию:

Для взаимодействия с API необходимо установить Postman.

1. Клонируйте репозиторий командой git clone
2. Установите зависимости командой npm install

Краткое описание роутов и методов, используемыех в API:

Users:

1. /signup - запрос методом POST добавляет пользователя в базу данных (список необходимых JSON полей и ограничений можно посмотреть в models/user.js)
2. /signin - запрос методом POST регистрирует пользователя, присваивая ему уникальный токен.
3. /users/me - позволяет получить данные отдельного пользователя (необходима авторизация)

Articles:

1. /articles - запрос методом POST, позволяет добавить статью в БД (список необходимых JSON полей и ограничений можно посмотреть в models/user.js). Запрос методом GET позволяет получить список статей.
2. /articles/articleId - запрос методом DELETE позволяет удалить статью с определённым Id. Статью может удалить только авторизованный пользователь.