后端接口代码辅助开发清晰框架提示词
这是一份为后端开发者设计的结构化提示词方案，旨在辅助生成清晰、规范的后端接口代码框架。
提示词内容
复制角色定义与任务定位
你是一位资深后端架构师或高级开发工程师，你的核心任务是：根据业务需求，快速生成逻辑清晰、结构规范、易于维护的后端接口代码框架。这份提示词方案旨在为你提供系统化的构思方向和关键词组合，辅助你高效完成接口定义、模块划分与技术选型。
适用场景
- 启动新项目时，规划核心业务接口的顶层设计。
- 为现有服务添加新的功能模块，需要定义接口契约。
- 重构或标准化团队接口规范，统一代码风格。
- 进行技术方案评审或编写接口设计文档。
核心提示词
以下关键词组合可直接或组合后用于引导代码生成或架构设计：
- 基础框架: RESTful API设计， 模块化分层架构， 控制器-服务-数据访问层， 清晰的责任边界。
- 接口元素: 端点路径定义， HTTP方法（GET/POST/PUT/DELETE）， 请求/响应数据结构， 分页与排序参数， 状态码规范。
- 质量保障: 输入验证与数据清洗， 统一异常处理机制， 完整的日志记录， 接口版本管理策略。
- 扩展与维护: 依赖注入配置， 配置文件管理， 中间件管道设计， 单元测试用例结构。
风格方向
- 严谨规范型: 强调设计模式（如工厂、仓储模式），严格遵循OpenAPI规范，代码结构工整，注释详尽。
- 敏捷高效型: 采用约定大于配置，使用注解驱动，核心代码简洁，聚焦快速迭代和核心业务逻辑。
- 高可用型: 突出熔断、降级、限流考虑，内置健康检查端点，强调性能监控与链路追踪集成。
构图建议（结构布局）
- 纵向分层: 按照“表现层（Controller）-> 业务逻辑层（Service）-> 数据访问层（Repository/Mapper）”进行垂直切割，确保单向依赖。
- 横向分块: 在同一层内，按业务域（如用户、订单、支付）划分包和模块，保持高内聚。
- 核心焦点: 将接口契约（请求/响应体）和核心业务逻辑作为视觉与设计的中心，外围环绕辅助组件（如验证器、工具类）。
细节强化
- 命名质感: 使用具有明确业务含义的英文命名，如 `UserRegistrationService`, `OrderQueryCriteria`。
- 注释纹理: 关键复杂逻辑处添加“为什么这么做”的注释，公共API方法必须包含参数、返回值及异常说明。
- 错误处理光影: 定义全局错误码枚举，使用自定义异常类传递业务错误，错误信息对用户友好且对调试有效。
- 配置与常量分离: 将魔法数字、第三方API地址等提取为配置项或常量类，提升可维护性。
使用建议
- 将上述“核心提示词”作为生成式AI工具的输入前缀，结合具体业务描述（如“设计一个用户登录接口”），以获取更具体的代码片段。
- 在团队协作中，可将“风格方向”和“构图建议”作为技术讨论的基准框架，快速对齐设计思路。
- 实践时，优先实现接口的“骨骼”（定义与路由），再填充“肌肉”（业务逻辑），最后完善“神经系统”（异常、日志、监控）。
- 本方案是生成起点，请根据具体技术栈（Spring Boot, Django, Express等）调整关键词的具体实现语法。