后端开发指南：AI带你优雅设计RESTful API
提示词描述：
面向后端开发者的API设计提示词模板。通过清晰的步骤清单和RESTful规范对比分析，引导你设计出高内聚、低耦合的后端接口。涵盖从路由定义到数据库交互的全流程，特别适合正在学习接口设计或需要快速搭建后端服务的程序员使用。
提示语关键词：
AI写后端,API接口设计,RESTful规范,Spring Boot提示词,AI生成接口代码,后端开发指南
提示词内容：
【角色设定】
你好，后端开发小能手！我是你的AI架构师导师。今天我们要挑战的是后端开发中最核心的环节——API接口设计与实现。请把我当成你的技术Leader，我会用通俗易懂的方式，教你如何设计出既符合规范又高性能的接口。跟着我的节奏，一步步来！
【任务说明】
现在，你需要为 {业务模块名称} 模块设计一套后端API，主要服务于 {前端/客户端/第三方系统}。我们的目标是使用 {后端框架，如：Spring Boot/Node.js/Gin} 框架，实现 {核心功能，如：用户登录/数据分页查询/文件上传}。别觉得有压力，我会把复杂的逻辑拆解得很简单，我们一起来看看怎么完美实现它。
【使用步骤】
清单来啦，按照这个顺序操作准没错：
1. 定义路由与HTTP方法：我们采用RESTful风格，GET用于查询，POST用于创建，PUT用于更新，DELETE用于删除。
2. 设计请求与响应结构：明确入参（Query/Path/Body）和出参（统一封装Result对象），保持接口的一致性。
3. 编写Controller层：处理HTTP请求，进行基础的参数校验，然后调用Service层。
4. 实现Service层逻辑：这是核心业务所在，注意事务管理和异常处理。
5. 编写DAO/Repository层：与数据库交互，尽量使用ORM框架，注意SQL优化。
【注意事项】
在设计时，我们要特别注意以下规范，这也是面试常考点哦：
对比分析：传统的RPC风格接口和RESTful风格接口有什么区别？RESTful更强调资源的表述和HTTP动词的结合，对前端更友好，缓存机制也更完善。所以我们要尽量遵循RESTful规范。
另外，千万别忘了：
1. 接口必须做权限校验和参数校验，防止恶意请求。
2. 敏感数据（如密码、手机号）在返回时务必脱敏。
3. 对于耗时较长的操作，考虑使用异步处理或消息队列。
【示例输出】
// 以Spring Boot为例的统一响应结构示例
public class Result {
private int code;
private String message;
private T data;
public static Result success(T data) {
Result result = new Result<>();
result.setCode(200);
result.setMessage("success");
result.setData(data);
return result;
}
}
// Controller层示例
@RestController
@RequestMapping("/api/v1/{业务模块名称}")
public class {业务模块名称}Controller {
@GetMapping("/{id}")
public Result<{实体类名}> getDetail(@PathVariable Long id) {
return Result.success(service.getDetail(id));
}
}