priorgnewb/user-service

Spring Boot, Spring Security, JWT, JPA, PostgreSQL, FlywayDB, Rest API

Сервис пользовательских данных.

Вся информация о пользователях хранится в PostgreSQL, пароли хешируются с использованием BCrypt.

Первичная аутентификация выполняется вводом логина и пароля, при успешном входе в систему будет сгенерирован JSON Web Token (JWT) - токен со сроком действия 24 часа.

В сервисе реализовано несколько API endpoint, часть из которых доступна только пользователям с ролью ADMIN. Предварительная аутентификация не требуется только при запросах к endpoint-ам регистрации/логина.

Реализована интеграция с FlywayDB - добавлены миграции, которые создают необходимые таблицы ролей (admin, user, moderator) и несколько пользователей. Файлы интеграции расположены в src/main/resources/db/migration. Для применения миграций нужно раскомментировать строки в конфигурационном файле application.properties. Пользователи с ролью администратора создаются с паролем adminpass, остальные - с паролем userpass

Используются Spring Boot, Spring Security, JWT, JPA, PostgreSQL, FlywayDB, Rest API.

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

1. Склонировать репозиторий

git clone https://github.com/priorgnewb/user-service.git

2. Создать базу данных PostgreSQL

create database taskdb

• run src/main/resources/taskdb.sql

3. Указать имя и пароль пользователя PostgreSQL

• открыть src/main/resources/application.properties
• изменить spring.datasource.username и spring.datasource.password на значения, используемые вами в PostgreSQL

4. Запустите приложение, используя Maven

mvn spring-boot:run

Приложение доступно по URL http://localhost:8080

Тестирование Rest APIs

Сервис предоставляет следующие CRUD APIs:

Аутентификация

Метод	URL	Описание	Валидный шаблон для запроса
POST	/api/auth/signup	Зарегистрироваться	JSON
POST	/api/auth/signin	Войти	JSON

Действия над пользователями

Метод	URL	Описание	Валидный шаблон для запроса
GET	/api/users/my	Показать профиль текущего пользователя
GET	/api/users/{username}/profile	Показать профиль пользователя с указанным username
POST	/api/users	Создать пользователя (для администраторов)	JSON
PUT	/api/users/{username}	Обновить профиль пользователя (для пользователя, вошедшего в систему, и для администраторов)	JSON
DELETE	/api/users/{username}	Удалить профиль пользователя (для пользователя, вошедшего в систему, и для администраторов)
PUT	/api/users/{username}/giveAdmin	Установить пользователю роль администратора (для администраторов)
PUT	/api/users/{username}/takeAdmin	Отозвать у пользователя роль администратора (для администраторов)

Служебные действия (для администраторов)

Метод	URL	Описание
GET	/api/admin/allusers	Показать список всех пользователей
GET	/api/admin/roles	Показать список доступных для назначения ролей
GET	/api/admin/alladmins	Показать список администраторов сервиса
GET	/api/admin/alladminsid	Показать список ID администраторов сервиса

Тестирование API возможно выполнять в Postman или в другом REST-клиенте.

Валидные шаблоны запросов в формате JSON

Зарегистрироваться -> /api/auth/signup

{
  "username": "Aleksey",
  "email": "[email protected]",
  "password": "alExDevve"
}

Войти -> /api/auth/signin

{
  "username": "Aleksey",
  "password": "alExDevve"
}

Создать пользователя -> /api/users

{
    "username": "egorlk",
    "email": "[email protected]",
    "password":"Pas1E!goR"
}

Обновить профиль пользователя (пароль) -> /api/users/{username}

{
  "username": "Aleksey",
  "email": "[email protected]",
  "password": "alExDevveNeWpAs!woRd"
}