moex-vibe/apps/docs/docs/development/codegen.md

Генерация кода

OpenAPI types

Frontend генерирует TypeScript-типы из Swagger-спецификации бэкенда.

Сгенерировать типы

npm run codegen -w apps/frontend

Выполняет:

openapi-typescript http://localhost:3000/api/docs-json -o src/api/types.ts

Требования

• Backend должен быть запущен на localhost:3000
• Swagger UI доступен на http://localhost:3000/api/docs

Результат

• apps/frontend/src/api/types.ts — сгенерированные типы paths и operations
• Live Swagger JSON на http://localhost:3000/api/docs-json остаётся источником OpenAPI-контракта

Проверка артефактов

После регенерации OpenAPI artifacts запустите:

npm run test -w apps/backend -- src/openapi-artifacts.spec.ts

Тест проверяет, что checked-in frontend types содержат актуальные auth, screener и portfolio paths и не содержат локальный alternate port.

Ручные типы

Помимо codegen, используются рукописные типы в apps/frontend/src/api/responses.ts. Они не полностью соответствуют codegen'овым и поддерживаются вручную.