FastApiAdmin ^v2.0.0

| 详情 | |----------|------|----------|------|----------|------| | 登录 |  | 首页 |  | 我的 |  | | 个人 |  | 设置 |  | 工作台 |  | ## 🛠️ 二开教程 ### 后端开发 1. **编写实体类层**：在 `backend/app/api/v1/module_generator/demo/model.py` 中创建 example 的 ORM 模型（对应 Spring Boot 中的实体类层） 2. **编写数据模型层**：在 `backend/app/api/v1/module_generator/demo/schema.py` 中创建 example 数据模型（对应 Spring Boot 中的 DTO 层） 3. **编写查询参数模型层**：在 `backend/app/api/v1/module_generator/demo/param.py` 中创建 example 的查询参数模型（对应 Spring Boot 中的 DTO 层） 4. **编写持久化层**：在 `backend/app/api/v1/cruds/module_generator/crud.py` 中创建 example 数据层（对应 Spring Boot 中的 Mapper 或 DAO 层） 5. **编写业务层**：在 `backend/app/api/v1/services/module_generator/service.py` 中创建 example 数据层（对应 Spring Boot 中的 Service 层） 6. **编写接口层**：在 `backend/app/api/v1/controllers/module_generator/controller.py` 中创建 example 数据层（对应 Spring Boot 中的 Controller 层） 7. **将 demo 模块添加至系统初始化脚本**：在 `backend/app/scripts/initialize.py` 中添加（如果需要可以把 demo 的菜单权限，配置到 `backend/app/scripts/data/system_menu.json` 和 `backend/app/scripts/data/system_role_menus.json` 或从前端页面菜单中新增） 8. **将 demo 模块添加至数据库迁移脚本中**：在 `backend/app/alembic/env.py` 中添加 ### 代码生成教程 代码生成模块是本项目的核心功能之一，可以帮助开发者快速生成完整的 CRUD 代码，大幅提升开发效率。该模块基于 Jinja2 模板引擎，可生成前后端一体化的完整功能模块。 #### 代码生成流程 1. **创建或导入数据表**： - 方式一：通过"创建表"功能直接在系统中创建新表 - 方式二：通过"导入"功能将现有数据库表导入到代码生成器中 2. **配置生成参数**： - 基础配置： - 表名称、表描述、实体类名称 - 生成配置： - 生成包路径（package_name）：如 `student` - 生成模块名（module_name）：如 `student` - 生成业务名（business_name）：如 `student` - 生成功能名（function_name）：如 `学生管理` - 生成代码方式：zip压缩包下载 或 项目目录写入 - 上级菜单：选择生成功能所属的菜单分类 3. **字段配置**： - 配置每个字段的： - 字段列类型、Python类型、Python字段名 - 是否为主键、是否自增、是否必填 - 是否为插入字段、编辑字段、列表字段、查询字段 - 查询方式（等于、不等于、大于、小于、范围） - 显示类型（文本框、文本域、下选框、复选框、单选框、日期控件） - 字典类型（用于下拉框数据源） 4. **代码预览**： - 预览将要生成的代码内容 - 支持预览后端（Python）、前端（Vue/TS）、数据库（SQL）代码 - 可按类型筛选预览内容 5. **生成代码**： - 点击"下载代码"生成并下载zip压缩包 - 点击"写入本地"直接写入到项目目录中 #### 生成的文件结构 代码生成器会生成完整的前后端代码结构： **后端文件**： - 控制器层：`backend/app/api/v1/module_{module_name}/{business_name}/controller.py` - 服务层：`backend/app/api/v1/module_{module_name}/{business_name}/service.py` - 数据访问层：`backend/app/api/v1/module_{module_name}/{business_name}/crud.py` - 数据模型层：`backend/app/api/v1/module_{module_name}/{business_name}/model.py` - 数据模式层：`backend/app/api/v1/module_{module_name}/{business_name}/schema.py` **前端文件**： - API接口文件：`frontend/src/api/module_{module_name}/{business_name}.ts` - 页面组件文件：`frontend/src/views/module_{module_name}/{business_name}/index.vue` **数据库文件**： - 菜单SQL文件：`backend/sql/module_{module_name}/{business_name}_menu.sql` #### 使用示例 1. 在数据库中创建新表，如 `sys_student` 2. 登录系统，进入**代码生成**模块 3. 点击"导入"，选择 `sys_student` 表 4. 配置生成参数： - 生成包路径：`student` - 生成模块名：`student` - 生成业务名：`student` - 生成功能名：`学生管理` - 上级菜单：系统管理 5. 配置字段属性（如设置哪些字段需要显示、查询、编辑等） 6. 点击"预览代码"查看生成的代码 7. 点击"下载代码"或"写入本地"生成完整功能模块 8. 重启服务，新功能模块即可使用 ### 前端部分 1. **前端接入后端接口地址**：在 `frontend/src/api/demo/example.ts` 中配置 2. **编写前端页面**：在 `frontend/src/views/demo/example/index.vue` 中编写 ### 移动端部分 1. **移动端接入后端接口地址**：在 `fastapp/src/api` 中编写 2. **编写移动端页面**：在 `fastapp/src/pages` 中编写 ## ℹ️ 帮助 更多详情请查看 [官方文档](https://service.fastapiadmin.com) ## 👥 贡献者 ## 🙏 特别鸣谢 感谢以下开源项目的贡献和支持： - [FastAPI](https://fastapi.tiangolo.com/) - [Pydantic](https://docs.pydantic.dev/) - [SQLAlchemy](https://www.sqlalchemy.org/) - [APScheduler](https://github.com/agronholm/apscheduler) - [Vue3](https://cn.vuejs.org/) - [TypeScript](https://www.typescriptlang.org/) - [Vite](https://github.com/vitejs/vite) - [Element Plus](https://element-plus.org/) - [UniApp](https://uniapp.dcloud.net.cn/) - [Wot-Design-UI](https://wot-ui.cn/) ## 🎨 社区交流 | 微信二维码 | 群组二维码 | 微信支付二维码 | | --- | --- | --- | |  |  |  | ## ❤️ 支持项目 如果你喜欢这个项目，请给我一个 ⭐️ Star 支持一下吧！非常感谢！ [](https://starchart.cc/1014TaoTao/FastapiAdmin)