Foadmin 开发文档

基于 Vue 3 + Vite 和 FastAPI 构建的企业级后台管理系统完整开发指南

文档目录

8. 开发规范

8.1 前端规范


  • 使用 Composition API 风格
  • 组件命名采用 PascalCase
  • API 接口封装在 src/api/ 目录下
  • 使用 Element Plus 组件库


8.2 后端规范


  • 路由注册统一在 app/routers/router_registry.py
  • 数据模型使用 SQLAlchemy 2.0 语法
  • 接口响应格式统一为 JSON
  • 使用 Pydantic 进行数据验证


8.3 数据库规范


  • 表名采用 foadmin_ 前缀
  • 字段名使用下划线命名法
  • 主键统一使用 id 字段
  • 时间戳字段使用 created_atupdated_at