diff --git a/README.md b/README.md index 4e85d76..9462435 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,36 @@ * Выводится сообщение об ошибке ### 7.Постусловия * Пользователь с указанным логином сохранен в БД +### 8.Маршруты +* `/api/v1/auth/register` - Регистрация пользователя +### 9.Контракт +#### Request +``` +{ + "login": "ivan_89", + "password": "S3cureP@ssw0rd" +} +``` +#### Требования к валидации: +* login: 3-50 символов, [a–z0–9._-], уникальное значение +* password: ≥ 8 символов + +#### Response - 201 - Created +``` +{ + "user": { + "login": "ivan_89" + } +} +``` + +#### Errors +* `409 USER_EXISTS` — пользователь с таким логином уже есть +* `422 VALIDATION_FAILED` — пустой логин/неправильный пароль +* `400 BAD_REQUEST` — сервер не смог десереализовать JSON + +### 10. Используемые сущности ДБ +* users(guid, login, hashed_password) ## UseCase №2 ### 1.Название: Авторизация пользователя