Auth Service Endpoints
Как запустить сервис
В корне проекта есть папка configs. В папке есть docker-compose. Необходимо запустить сервисы: auth, postgres.
Как протестировать сервис
Открываем Postman и рабочее пространство Lious. Все методы находятся в папке Auth Service.
Как изменить параметры по умолчанию
Конфиги находятся здесь:
-
configs/databases/postgres/init.sql
-
configs/services/auth/configuration.yml
Параметры сервиса:
|
Параметр |
Описание |
Значение по умолчанию |
|
port |
Порт на котором работает сервис |
5340 |
|
connectionString |
Строка подключения к базе Postgres |
"postgres://username:password@postgres:5432/users?sslmode=disable" |
|
secretKey |
Ключ на основе которого создаются JWT токены |
"e=>Np5vWo!+v3uCY!2ss" |
Подробное описание механизмов и параметров:
secretKey - ключ требуется для создания токена JWT и его подписи. Также ключ потребуется в других сервисах для проверки подписи токена. По умолчанию токен JWT действителен в течение часа. Для повышения безопасности можно использовать ассиметричное шифрование (используются публичные и приватные ключи). На основе приватного ключа создается токен и подпись. А с помощью публичного ключа происходит проверка подписи.
|
Done?
|
Method
|
HTTP method
|
Address
|
Description
|
||
|---|---|---|---|---|---|---|
|
1
|
Login |
POST |
/auth/login |
Метод проверяет наличие пользователя в системе. Далее сверяет пароли. Если пароли совпадают то возвращает JWT токен. Если не совпадают то возвращает 401 Unauthorized. |
||
|
2
|
Register |
POST |
/auth/register |
Метод создает хэш пароля на основе текстового пароля. Далее создается пользователь в базе данных. Задается UID и время создания записи. Если все операции успешные то метод возвращает JWT токен. |
||