Документация FinGuide¶

Документация бэкенда/API для FinGuide.

Что здесь находится¶

Контракт API — договор между бэкендом и фронтендом.
Аналитическая Excel-модель — разбор Excel-модели, которую бэкенд должен воспроизводить.
Архитектура бэкенда и Keycloak — целевая архитектура продукта.
Модули бэкенда — структура Java-пакетов и границы модулей.

Быстрые ссылки¶

Репозиторий GitHub: https://github.com/svoronkov-les13/finguide-be
Swagger UI реального бэкенда: http://66.42.121.18/finguide-api/swagger-ui.html
OpenAPI JSON реального бэкенда: http://66.42.121.18/finguide-api/v3/api-docs
База/индекс реального API: http://66.42.121.18/finguide-api/api/v1
Пример живого endpoint: http://66.42.121.18/finguide-api/api/v1/plans/current
Публичный предпросмотр контракта: http://66.42.121.18/finguide-contract/
JSON-спецификация OpenAPI в репозитории: https://github.com/svoronkov-les13/finguide-be/blob/main/openapi/openapi.json
Legacy mock Swagger, только на период перехода: http://66.42.121.18/finguide-mock/
Keycloak deployment guide: deploy/keycloak/README.md

Текущий статус реализации¶

Real Spring Boot backend сейчас обслуживает:

индекс API GET /api/v1;
чтение текущего плана, дашборда, health/cashflow и списка сценариев;
CRUD доходов, расходов и целей;
Keycloak/OIDC security boundary: JWT Resource Server, GET /api/v1/me, lazy profile mapping, plan ownership checks, and frontend session restore without demo/default profile flash;
POST /plans/{planId}/goals/reorder для сохранения waterfall-приоритета целей.

Оставшиеся группы контракта ведутся отдельными задачами GitHub Issues.

Главная договорённость¶

Фронтенд редактирует входные данные и показывает рассчитанные значения. Бэкенд владеет финансовой логикой:

PlanState + ModelAssumptions
  -> годовой денежный поток
  -> сбережения и накопленный капитал
  -> пенсионная проекция
  -> дашборд, оценка финансового здоровья и сценарии

Главный метод API для производных расчётов:

GET /plans/{planId}/analytics/cashflow