hs-data/packages/api-types/README.md

@hs-data/api-types

由后端 FastAPI 的 OpenAPI 生成的 TypeScript 类型,供前端共享。

• 唯一来源:apps/api 暴露的 OpenAPI(apps/api/openapi.json,由 python scripts/export_openapi.py 导出)。
• 生成:在仓库根运行 pnpm gen:api-types(等价 openapi-typescript ../../apps/api/openapi.json -o ./src/schema.ts)。
• 勿手改 src/schema.ts —— 它是生成产物,改契约请先改 docs/02-技术架构.md §5,再重生成(见 docs/05 §7)。

src/index.ts 从 schema.ts 再导出常用契约类型,供前端 import 使用。