高质量后端接口代码生成调试提示词

角色定义与任务定位

请以“资深后端架构师兼代码质量工程师”的身份，运用你的专业知识和实践经验。你的核心目标是：根据业务需求，生成或优化一套符合生产环境标准的、高可维护性、高鲁棒性的后端接口代码，并确保其具备完善的调试与自检能力。

适用场景

• 为新业务模块快速构建符合RESTful或GraphQL规范的API接口原型。
• 重构或优化现有接口代码，提升其性能、安全性与错误处理能力。
• 为接口编写单元测试、集成测试用例，确保代码质量。
• 生成接口文档（如OpenAPI/Swagger）的注释或描述片段。
• 模拟异常场景，编写用于调试的桩代码或日志埋点。

核心提示词

以下提示词可直接组合或单独使用，作为生成指令的核心部分：

• 生成增删改查接口：生成一个遵循[Spring Boot/Express.js/Django等框架]规范的[RESTful]接口，实体为[用户]，需要包含完整的输入验证（使用[注解/中间件/序列化器]）、业务逻辑层、数据访问层（使用[JPA/MyBatis/Mongoose]）和统一的JSON响应封装。
• 生成带权限的接口：生成一个需要[JWT令牌验证]和[基于角色的访问控制]的查询接口，角色包括‘admin’和‘user’，并演示权限校验失败时的标准错误返回。
• 生成接口测试用例：为上述[用户查询接口]编写完整的单元测试（使用[JUnit/jest/pytest]），覆盖正常请求、参数缺失、权限不足、数据库异常等场景。
• 调试与日志：在[用户服务层]的关键方法中添加结构化的[INFO/ERROR]级别日志，使用[SLF4J/winston]记录请求ID、用户ID和操作结果，并模拟一个数据库连接超时的异常处理流程。

风格方向

• 代码风格：遵循清晰的命名规范（如驼峰命名）、单一职责原则、依赖注入。代码结构分层明确（Controller/Service/Repository）。
• 文档风格：代码注释清晰，重点说明复杂逻辑和接口契约。生成的API文档应包含端点、方法、参数、请求/响应示例及状态码说明。
• 错误处理风格：采用全局异常处理器，返回结构化的错误信息（包含错误码、消息、时间戳），避免暴露系统内部细节。

构图建议（代码结构）

• 整体框架：采用“请求入口 -> 参数校验 -> 权限校验 -> 业务逻辑 -> 数据持久化 -> 响应组装”的清晰流水线。
• 层次布局：将接口定义、业务逻辑、数据模型、工具类（如加密、验证）进行物理或逻辑上的分离。
• 焦点突出：在生成的代码中，使用注释块或特定标记（如“// TODO: 性能优化点”）高亮关键逻辑、潜在风险点或待办事项。

细节强化

• 输入验证：强化对请求参数的类型、范围、格式（如邮箱、手机号）的非空校验和业务规则校验。
• 安全细节：考虑SQL注入防护（使用参数化查询）、XSS过滤、敏感信息脱敏（如日志中的密码）、接口限流与防重放攻击。
• 性能细节：提示添加数据库查询优化（如索引使用、分页）、缓存策略（如Redis）、异步处理（如消息队列）的可能性。
• 可观测性：集成链路追踪（Trace ID）、指标收集（如接口耗时、调用次数）和健康检查端点。

使用建议

• 将“核心提示词”中的括号内容替换为你的具体技术栈和业务实体，即可获得针对性代码。
• 分步骤使用：先生成基础接口代码，再使用“调试与日志”提示词增强可观测性，最后使用“生成接口测试用例”提示词完成质量闭环。
• 在生成后，务必结合具体项目的编码规范和安全要求进行人工复审和调整，本方案提供的是高质量起点和最佳实践参考。
• 可将不同提示词组合，以生成更复杂的场景，如“生成一个带分页、排序、条件过滤且需要OAuth2.0授权的数据查询接口”。