AI 助手配置使用指南

购买 EasyAdminBlazor 源码后,附赠一套针对本框架优化的 AI 助手配置:让 ChatGPT / Cursor / Claude 按照框架的开发约定,直接帮你生成规范、可编译的业务代码。

包含什么

资产 位置 作用
easyadmin-conventions 技能 源码仓库 .github/skills/easyadmin-conventions/SKILL.md 项目强制开发约定:架构、命名、实体模型、页面模式、DI 注册、安全、测试、反模式
easyadmin-frontend 技能 源码仓库 .github/skills/easyadmin-frontend/SKILL.md 从实体一键生成后台 CRUD 页面(AdminTable)与前台企业站页面
企业站模板 easyadmin-frontend/assets/templates/corporate/ 标准企业站模板:首页 / 服务 / 产品 / 新闻 / 联系我们,含示例数据与示例图

在 ChatGPT 中使用

  1. 打开支持 Skills 的 ChatGPT 项目 / 助手,在配置中添加技能目录 .github/skills/(或分别添加两个 SKILL.md)。
  2. 直接提需求,例如:
    • “给我生成产品模块的前后台页面:后台 CRUD(AdminTable)+ 前台列表/详情页”
    • “为公司官网搭一个企业站:首页、服务、产品、新闻、联系我们”
  3. AI 会先读取 easyadmin-conventions 约定再动手,输出符合框架规范的代码。

在 Cursor / Claude 中使用

  1. 将两个 SKILL.md 的内容加入项目的 Cursor Rules(.cursor/rules/ 或 .cursorrules)或 CLAUDE.md。
  2. 让 AI 参考规则生成或重构模块,例如:
    • “给留言反馈做一个后台列表页,只读即可”
    • “检查我新增的模块是否符合 easyadmin-conventions 约定,并修正”

常用 Prompt 示例

  • 生成前后台模块:给我生成产品模块的前后台页面:后台 CRUD(AdminTable)+ 前台列表/详情页(实体不存在时会按约定自动创建)
  • 生成前台页面:给新闻做一个前台列表页和详情页,带分类筛选
  • 搭建企业站:为公司官网搭一个企业站:首页、服务、产品、新闻、联系我们
  • 生成后台页面:给留言反馈做一个后台列表页,只读即可
  • 代码审查:检查我新增的模块是否符合 easyadmin-conventions 约定,并修正

提示:直接说业务名称即可,例如“产品”“新闻”“留言反馈”。AI 会先定位或创建对应实体,再按技能流程生成页面;不用自己先建好实体。

生成后的自查清单(反模式)

  • 前台页面禁止注入 IFreeSql,一律使用 IBaseRepository<TEntity>
  • 导航属性不要写 = null!:可选属性用 nullable,集合用 = []
  • 枚举成员必须使用英文
  • 富文本仅后台可信内容可用 Html.Raw
  • 前台页面不要套用后台 MainLayout,使用独立前台布局
  • 实体字符串字段不要 = null!,使用 = string.Empty

配套文档

  • 仓库 doc/代码生成.md:类型 → 组件映射
  • 仓库 doc/开始一个新模块.md:新模块开发流程