Перейти к основному содержимому

WMS — Техническая документация

Техническая документация для разработчиков WMS-системы.

Бизнес-документация (для операторов, менеджеров, интеграторов) находится в отдельном проекте wms-autodoc.

Содержание

РазделОписание
Обзор системыТехнологический стек, структура проекта, сборка и запуск
АрхитектураКлючевые архитектурные решения и паттерны
Доменная модельДокументы, сущности, регистры, перечисления
APIEmployee API, Merchant API, System API
БезопасностьАутентификация, авторизация, multi-tenancy
ИнтеграцииВнешние системы: ERP, ApiShip, S3, Telegram
РуководстваКак добавить документ, движение, форму, справочник
АнализСравнительный анализ с бизнес-документацией

Быстрый старт

# Сборка
./gradlew build

# Запуск
./gradlew bootRun

# Порт по умолчанию: 30040
# Swagger UI: http://localhost:30040/doc/index.html

Ключевые характеристики проекта

ПараметрЗначение
ЯзыкJava 21
ФреймворкSpring Boot 3.4.2
СУБДPostgreSQL
ORMHibernate 6.x + Envers (аудит)
МиграцииLiquibase 4.31
СборкаGradle 8.5
КешCaffeine 3.2
ОтчётыJasperReports 7.0.1
ФайлыAWS S3
МетрикиMicrometer + Prometheus
API-документацияSpringDoc OpenAPI 2.8.13