实战型后端接口代码辅助开发提示词
这是一份专为后端开发者设计的实战型提示词方案,旨在辅助高效生成高质量、结构清晰的接口代码。
提示词内容
复制角色定义与任务定位
你是一位经验丰富的后端架构师或高级开发工程师。你的核心任务是利用AI辅助工具,快速、规范地生成可运行、易维护的后端接口代码。你的目标不是获取零散代码片段,而是获得结构完整、考虑周全、可直接用于项目开发的代码方案,并在此过程中优化设计思路。
适用场景
- 快速搭建新功能模块的RESTful API接口骨架。
- 为已有业务逻辑补充完整的数据校验、异常处理和响应封装。
- 根据数据库表结构或接口文档,生成对应的控制器(Controller)、服务(Service)及数据访问层代码。
- 重构或优化旧接口,引入更清晰的分层结构与设计模式。
核心提示词
以下提示词可直接复制使用,请替换 `{ }` 中的具体内容:
- “作为一名后端开发者,请使用{Java/Go/Python等语言}和{Spring Boot/Gin/Django等框架},为一个`{用户管理}`模块设计一个完整的`新增用户`接口。要求包含请求参数校验(使用注解/声明式验证)、业务逻辑处理(密码加密、唯一性检查)、数据库操作(使用ORM/Repository模式)、统一的JSON响应封装(包含成功/失败状态码、消息和数据体)以及详细的日志记录。”
- “根据以下数据库表结构,生成对应的CRUD接口代码。表名:`product`,字段:`id (主键), name (字符串,非空), price (小数,非空), stock (整数,默认0), is_deleted (软删除标志)`。要求代码分层清晰,包含Controller、Service、Repository/DAO层,并实现逻辑删除。”
- “为`订单支付`回调接口设计一个幂等的处理函数。要求考虑网络重试、重复通知、事务一致性,并给出核心处理逻辑的伪代码或具体代码。”
风格方向
- 代码风格:遵循行业与团队规范,如清晰的命名(驼峰法)、合理的注释(解释Why而非What)、适度的空行分隔逻辑块。
- 架构风格:提倡分层架构(如MVC、DDD分层),强调单一职责原则。代码应体现高内聚、低耦合的特性。
- 文档风格:生成的代码应便于生成API文档(如Swagger/OpenAPI注解),接口意图一目了然。
构图建议(代码结构布局)
- 分层构图:像规划建筑平面图一样组织代码层级。Controller层处理HTTP协议与路由,Service层承载核心业务逻辑,Repository/DAO层专注数据存取。
- 模块化构图:将相关功能聚合在同一个模块包(package)内,形成独立的“功能单元”。
- 顺序构图:在单个方法内,代码应按“参数校验 -> 业务准备 -> 核心逻辑 -> 数据持久化 -> 响应组装”的清晰流线排列。
细节强化
- 安全性:明确提示加入输入验证、SQL注入防护、敏感数据脱敏等安全措施。
- 健壮性:要求生成完整的异常处理(try-catch或错误返回码)、边界条件判断(空值、极限值)。
- 可观测性:强调在关键步骤添加业务日志和指标埋点,便于监控和调试。
- 性能暗示:在提示词中提及“考虑并发场景”、“使用缓存优化”、“数据库查询优化”等方向,引导生成更优质的代码。
使用建议
- 在使用核心提示词时,尽可能具体地描述业务规则和约束条件,AI生成的代码会更具针对性。
- 将生成的代码视为高质量的“初稿”,务必进行人工审查、测试和必要的调整,以完全契合项目上下文。
- 可以要求AI为复杂接口生成配套的单元测试用例骨架,提升代码质量。
- 积累有效的提示词模板,形成个人或团队的“接口代码提示词库”,持续提升开发效率。