REST API для работы со справочником организаций, зданий и видов деятельности.
Реализовано на FastAPI, с использованием SQLAlchemy, Pydantic и Alembic.
Поддерживается работа в Docker и документация в Swagger UI / ReDoc.
- CRUD-операции с организациями, видами деятельности и зданиями
- Фильтрация по зданиям, видам деятельности (включая вложенные) и геолокации
- Ограничение вложенности видов деятельности до 3 уровней
- Авторизация через API-Key
- Python 3.12+
- FastAPI
- SQLAlchemy (Async)
- Alembic
- PostgreSQL
- Docker & Docker Compose
-
Клонировать репозиторий:
git clone https://github.com/shipilov-maxim/handbook.git cd handbook -
Создать .env файл на основе .env_sample и указать свои переменные.
-
Запустить через Docker:
docker compose up --build- Документация API:
-
Swagger UI: http://127.0.0.1:8000/docs
-
ReDoc: http://127.0.0.1:8000/redoc