72 lines
3.0 KiB
Markdown
72 lines
3.0 KiB
Markdown
# API-контракты портала DetMir
|
||
|
||
## Цель
|
||
|
||
Закрепить стабильный слой API для текущего HTML-портала и будущего
|
||
React/Tauri-интерфейса без переписывания backend-логики.
|
||
|
||
Текущий HTML-портал остаётся рабочим и основным. Новый UI должен подключаться к
|
||
тем же endpoint-ам через documented contract.
|
||
|
||
## Контрактные endpoint-ы
|
||
|
||
Основной портал:
|
||
|
||
- `GET /api/contracts`
|
||
- `GET /api/contracts/openapi.json`
|
||
- `GET /api/contracts/typescript.d.ts`
|
||
|
||
DPD mirror:
|
||
|
||
- `GET /dpd/api/contracts`
|
||
- `GET /dpd/api/contracts/openapi.json`
|
||
- `GET /dpd/api/contracts/typescript.d.ts`
|
||
|
||
## Правила совместимости
|
||
|
||
- Изменения API должны быть additive.
|
||
- Нельзя удалять существующие поля без отдельной migration window.
|
||
- Клиенты обязаны игнорировать неизвестные поля.
|
||
- Клиенты обязаны корректно обрабатывать отсутствующие optional-поля.
|
||
- Поля с `null` не должны ломать UI.
|
||
- Ошибки API должны отображаться пользователю на русском языке.
|
||
|
||
## Минимальный набор для будущего React/Tauri UI
|
||
|
||
Для первого production-grade клиента достаточно:
|
||
|
||
- `GET /api/contracts` - discovery и версия контракта;
|
||
- `GET /api/reports` - главный управленческий payload;
|
||
- `GET /api/operator` - обзор портала;
|
||
- `GET /api/incidents` - проверки и события;
|
||
- `GET /api/cases` - расследования;
|
||
- `POST /api/incident-review` - ручное решение по кандидату;
|
||
- `POST /api/cases` - ручное создание дела;
|
||
- `GET /api/investigation-pack/{candidate_id}` - пакет расследования;
|
||
- `GET /api/readiness/latest` - готовность системы;
|
||
- `GET /api/workforce/policy/explain` - объяснение расчёта показателей.
|
||
|
||
## Что не меняется
|
||
|
||
- HTML-портал не удаляется.
|
||
- Маршрут `/portal/` остаётся стабильным.
|
||
- DPD `/dpd/` остаётся параллельным mirror.
|
||
- Backend-расчёты, JSON-хранилища и workflow не дублируются во frontend.
|
||
|
||
## Проверка
|
||
|
||
```bash
|
||
curl -sS http://127.0.0.1:8720/api/contracts | jq .
|
||
curl -sS http://127.0.0.1:8720/api/contracts/openapi.json | jq .openapi
|
||
curl -sS http://127.0.0.1:8720/api/contracts/typescript.d.ts | head
|
||
curl -sS http://127.0.0.1:8722/api/contracts | jq .
|
||
```
|
||
|
||
Ожидаемый результат:
|
||
|
||
- `ok=true`;
|
||
- `contract_version` заполнен;
|
||
- OpenAPI JSON валиден;
|
||
- TypeScript declarations доступны;
|
||
- DPD отдаёт те же контрактные endpoints через mirror.
|