高效后端接口Agent工作流设计提示词

角色定义与任务定位

请以“后端系统架构师与自动化流程设计师”的身份，运用这份提示词。你的核心目标是：生成一套结构化、可执行的方案，用于指导AI Agent或开发团队，系统化地设计、实现与优化高性能、可维护的后端API接口及其自动化工作流。你的产出不是概念阐述，而是可直接驱动开发或配置的具体行动指南。

适用场景

• 规划与设计新的微服务或模块的API接口规范。
• 重构或优化现有后端接口，提升其性能与可维护性。
• 为API网关、Mock服务、自动化测试等环节设计Agent协作流程。
• 构建从接口设计、代码生成、文档同步到监控告警的端到端自动化开发流水线。

核心提示词

以下提示词组合可直接用于向AI模型（如GPT、Claude等）或开发团队下达明确指令：

• 基础生成指令：基于[业务模块名称，如“用户中心”]，设计一套遵循RESTful规范的高效后端接口。明确请求/响应格式、状态码、错误处理机制，并输出OpenAPI 3.0规范的YAML草案。
• 工作流设计指令：设计一个多Agent协作工作流，用于自动化处理“从接口设计到生成对应Spring Boot控制器代码、数据库迁移脚本及API文档”的全过程。定义每个Agent（如设计Agent、代码生成Agent、校验Agent）的职责与触发条件。
• 质量强化指令：为上述接口设计添加限流（Rate Limiting）、缓存（Cache-Control头策略）、幂等性（Idempotency Key）保障以及详细的性能考量点（如N+1查询避免）。
• 扩展指令：为该接口工作流集成自动化测试Agent，使其能在代码生成后，自动创建并运行针对边界条件、异常场景的集成测试用例。

风格方向

• 架构风格：清晰的分层架构（Controller/Service/Repository），强调契约优先（API First）的设计理念。
• 文档风格：生成的技术文档与代码注释应保持专业、精确、无歧义，符合团队编码规范。
• 流程风格：工作流设计应模块化、可观测，每个步骤都有明确的输入、输出和成功/失败状态，便于监控和调试。

构图建议

当需要将此类工作流进行可视化呈现时，建议采用以下构图元素：

• 流程图框架：使用横向泳道图（Swimlane Diagram）区分“设计阶段”、“开发阶段”、“测试阶段”等不同环节。
• 节点元素：用不同形状的节点（如圆角矩形代表处理Agent，菱形代表决策点，文档图标代表产出物）清晰表示工作流中的各个组件。
• 连接与数据流：用箭头明确连接线表示触发顺序与数据流向，并在线旁标注传递的数据对象或事件名称。
• 重点高亮：将核心Agent（如“接口校验Agent”）、关键产出（如“最终的OpenAPI规范”）或可能的风险点用醒目的颜色或边框进行标注。

细节强化

• 接口细节：明确路径参数、查询参数的校验规则（正则表达式）；定义响应体的统一封装格式（如{“code”: 200, “data”: {}, “msg”: “success”}）；规划API版本管理策略（如URL路径版本化）。
• 工作流细节：为每个Agent设定清晰的失败回滚（Rollback）机制与告警方式（如发送至钉钉/Slack）；定义人工审核介入的节点（如对核心接口设计的确认）。
• 非功能细节：考虑接口的监控指标（如P95延迟、错误率）、日志记录规范（包含唯一请求ID）以及与安全Agent的集成（用于自动扫描敏感信息泄露）。

使用建议

• 将核心提示词作为与AI对话的起点，根据具体业务需求替换“[ ]”中的占位符，并迭代细化要求。
• 生成的OpenAPI规范YAML文件，可直接导入Postman、Swagger UI等工具进行模拟测试与文档共享。
• 工作流设计图（基于构图建议绘制）可用于团队评审和技术方案宣讲，确保流程共识。
• 在实际开发中，可将此方案拆解为具体的开发任务，并利用代码模板、CI/CD管道工具（如Jenkins、GitLab CI）来实现工作流的自动化部分。