Учебный проект для изучения работы во фреймворке FastAPI.
QRkot - это API сервиса по сбору средств для финансирования благотворительных проектов. В сервисе реализована возможность регистрации пользователей, добавления благотворительных проектов и пожертвований, которые распределяются по открытым проектам.
Настроено автоматическое создание первого суперпользователя при запуске проекта.
- Склонируйте репозиторий:
git clone git@github.com:Hastred45/cat_charity_fund.git
- Активируйте venv и установите зависимости:
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
- Создайте в корневой директории файл .env со следующим наполнением:
APP_TITLE=Приложение QRKot.
APP_DESC=Спасем котиков вместе!
DATABASE_URL=sqlite+aiosqlite:///./<название базы данных>.db
SECRET=<секретное слово>
FIRST_SUPERUSER_EMAIL=<email суперюзера>
FIRST_SUPERUSER_PASSWORD=<пароль суперюзера>
- Примените миграции для создания базы данных SQLite:
alembic upgrade head
- Проект готов к запуску.
Для локального запуска выполните команду:
uvicorn app.main:app --reload
Сервис будет запущен и доступен по следующим адресам:
- http://127.0.0.1:8000 - API
- http://127.0.0.1:8000/docs - автоматически сгенерированная документация Swagger
- http://127.0.0.1:8000/redoc - автоматически сгенерированная документация ReDoc
После запуска доступны следующие эндпоинты:
- Регистрация и аутентификация:
- /auth/register - регистрация пользователя
- /auth/jwt/login - аутентификация пользователя (получение jwt-токена)
- /auth/jwt/logout - выход (сброс jwt-токена)
- Пользователи:
- /users/me - получение и изменение данных аутентифицированного пользователя
- /users/{id} - получение и изменение данных пользователя по id
- Благотворительные проекты:
- /charity_project/ - получение списка проектов и создание нового
- /charity_project/{project_id} - изменение и удаление существующего проекта
- Пожертвования:
- /donation/ - получение списка всех пожертвований и создание пожертвования
- /donation/my - получение списка всех пожертвований аутентифицированного пользователя
Со схемами запросов и ответов можно ознакомиться в документации или в файле со спецификацией - openapi.json.
Sergei Osetrov