finyxdata/README.md

2.5 KiB
Raw Permalink Blame History

Finyx Data - 更新说明(后续研发指引)

本仓库包含“数据资产盘点/价值挖掘”相关的AI 后端服务、业务后端服务、前端工程以及用于评审的原型界面。本文用于统一说明各目录职责与后续研发协作方式。

目录职责与边界(必读)

finyx_data_ai_backend/(大模型与 AI 技术相关后台服务)

  • 定位专注大模型能力、AI 算法/提示词工程、AI 相关工具链与接口封装。
  • 对接方式:通过 API 接口与其他服务/前端对接(不直接耦合具体业务后端实现)。
  • 推荐入口文档
    • finyx_data_ai_backend/README.md
    • finyx_data_ai_backend/API_DOCUMENTATION.md
    • finyx_data_ai_backend/研发进度说明.md

finyx_data_backend/前后端分离架构的业务后端服务Python

  • 定位:业务后端(非 AI提供业务数据、权限、项目流程等后端能力。
  • 技术:采用 Python 提供后端服务(具体框架与启动方式以目录内文档/脚本为准)。
  • 对接方式:向 finyx_data_frontend/ 提供业务 API必要时再去调用 finyx_data_ai_backend/ 的 AI 能力接口。

finyx_data_frontend/(前端开发目录)

  • 定位:正式前端工程,与 finyx_data_backend/finyx_data_ai_backend/ 等后端目录对接。
  • 对接方式:通过环境配置(如 baseURL/代理)对接后端接口;接口以各后端的 API 文档为准。

frontend_demo/(新设计原型界面:设计/演示/评审)

  • 定位:用于前期设计与演示,支持评审确认与快速迭代;不作为最终生产代码的唯一来源。
  • 融合策略:评审确认后,将原型中确认的页面结构、交互与组件方案逐步融合finyx_data_frontend/
    • 先对齐:路由结构、页面信息架构、交互流程
    • 再迁移:通用组件、样式规范、状态管理模式
    • 最后接入:真实接口联调、鉴权、错误处理、埋点/日志等工程化能力

协作约定(建议)

  • 接口优先:以各后端目录下的 API 文档为准;接口变更需同步更新对应文档并标注版本/日期。
  • 边界清晰AI 能力统一在 finyx_data_ai_backend/ 对外提供;业务后端避免在前端直接散落多套 AI 调用逻辑。
  • 原型到生产frontend_demo/ 仅做设计与评审载体;生产交付以 finyx_data_frontend/ 为准。