From 840d01eab363a938aa14a34b40d8fc6b5817dded Mon Sep 17 00:00:00 2001 From: zhouyonggao <1971162852@qq.com> Date: Thu, 12 Mar 2026 12:09:49 +0800 Subject: [PATCH] =?UTF-8?q?docs(spec):=20=E5=88=A0=E9=99=A4=E8=99=9A?= =?UTF-8?q?=E6=8B=9F=E5=95=86=E5=93=81=E5=85=85=E5=80=BC=E6=9C=8D=E5=8A=A1?= =?UTF-8?q?=E5=95=86=E7=B3=BB=E7=BB=9F=E4=BA=A7=E5=93=81=E9=9C=80=E6=B1=82?= =?UTF-8?q?=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 完全移除包含详细功能模块划分、接口说明、数据实体及流程图的产品需求文档 - 删除模块关系表、业务规则、输入输出字段及验收标准 - 清理用户故事、错误码说明、附录中专业术语和业务响应码 - 移除服务类型、厂商编码及渠道标识等所有相关描述 - 规范文档结构整体清理,去除所有内容,保持文档根目录无虚拟商品相关文件 --- .qoder/rules/api.md | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/.qoder/rules/api.md b/.qoder/rules/api.md index c6fc499..026a946 100644 --- a/.qoder/rules/api.md +++ b/.qoder/rules/api.md @@ -1,5 +1,39 @@ --- trigger: model_decision -description: 后端API服务编码规范、技术栈,生成、修改后端api代码时参考 +description: --- +# API 编码规范 + +**技术栈**: Go 1.22.2 + Fiber v2 + GORM + Redis + Wire + +**项目结构**: +- `biz/` - 业务层(接口定义) +- `data/` - 数据层(接口实现、数据库) +- `server/` - 路由层 +- `service/` - 应用服务层 + +**开发流程**: +1. `conf/conf.go` - 添加配置 +2. `biz/repository/` - 定义仓储接口 +3. `data/repositoryimpl/` - 实现接口 +4. `data/provider_set.go` - 注册 Provider +5. `server/http.go` - 添加路由 +6. `make wire` - 生成依赖注入代码 +7. 调用 code_review 进行代码评审 + +**常用命令**: +```bash +make wire # 生成 Wire +make build # 构建 +``` + +**代码规范**: +- 符合 Go 基本原则(命名清晰、错误处理、上下文传递) +- 合理应用设计模式(工厂、策略、适配器等) +- 遵循设计原则(SOLID、DRY、KISS) +- 使用 TDD 驱动开发(先写测试,后写实现) +- 禁止硬编码(配置化、常量提取) +- 函数第一参数: `context.Context` +- 导入路径前缀: `trans_hub/app/ymt/post_bank_point_mall/service/...` +