axdjuraev / fastapi-referral-system-api Goto Github PK

RESTful API сервис для реферальной системы

• регистрация и аутентификация пользователя (JWT, Oauth 2.0);
• аутентифицированный пользователь должен иметь возможность создать или удалить свой реферальный код. Одновременно может быть активен только 1 код. При создании кода обязательно должен быть задан его срок годности;
• возможность получения реферального кода по email адресу реферера;
• возможность регистрации по реферальному коду в качестве реферала;
• получение информации о рефералах по id реферера;
• UI документация (Swagger/ReDoc).

Нужно скопировать .env.example в .env и настроить параметры в .env

cp .env.example .env

1. Для регистрации пользователя необходимо сначала отправить запрос POST на адрес /api/v1/auth/send-validation-code с телом запроса что бы получить OTP код для валидации.

POST http://localhost:8000/api/v1/auth/send-validation-code/[email protected]

2. После получения кода, пользователь должен отправить запрос POST на адрес /api/v1/auth/register с параметром otp и с телом запроса:

POST http://localhost:8000/api/v1/auth/register?otp=123456

{
  "first_name": "string",
  "last_name": "string",
  "email": "[email protected]",
  "referral_code": "string",
  "password": "string"
}

3. После регистрации пользователя должен получить JWT токен для входа:

POST http://localhost:8000/api/v1/auth/login

{
  "username": "[email protected]",
  "password": "****"
}

4. ...

Установка зависимостей:

pip install -r requirements.txt

Применение миграций базы данных

python3 -m alembic upgrade head

Запуск сервиса

python3 -m uvicorn --factory src.main:create_app

Доступ к UI документациям:

http://localhost:8000/docs
http://localhost:8000/redoc