项目规范

API 规范

• API Types 命名请求遵循 Req 结尾为请求, Resp 结尾为返回值, Info 结尾为信息体
• 建议添加详细注释用于生成 swagger, 我们支持 go swagger 注释，只需添加到字段上即可
• 建议文件名风格为 go_zero , 跟随 Golang 规范

RPC 规范

• proto 文件拆分定义在 desc 文件夹中
• 可选字段使用 optional

注意

Goctls 会将 desc 内的 proto 合并到根目录，单个 proto 文件在 IDE 报错是正常的，最终合并后的文件内不应该报错

Ent 规范

• 所有字段都应该填写注释（Comment）, 用于全局注释生成
• 建议手动配置表注释
• 不建议开启外键关联