
一、资源设计RESTful API的核心是“资源”。简记往来的核心资源资源URL说明账本/api/books用户创建的账本成员/api/members账本成员记录/api/records礼金记录联系人/api/contacts联系人档案二、HTTP方法映射操作HTTP方法URL说明创建账本POST/api/books新建一个账本获取账本列表GET/api/books获取用户所有账本获取账本详情GET/api/books/{id}获取单个账本信息更新账本PUT/api/books/{id}修改账本名称删除账本DELETE/api/books/{id}解散账本三、状态码规范状态码含义使用场景200OK请求成功201Created创建成功400Bad Request参数错误401Unauthorized未登录403Forbidden无权限404Not Found资源不存在500Internal Server Error服务器错误四、错误处理统一格式所有错误响应使用统一格式{code:40001,message:参数缺失bookId,timestamp:1700000000000}错误码规范40001-40099参数错误40100-40199认证错误40300-40399权限错误40400-40499资源不存在50000-50099服务器错误五、核心接口示例创建记录POST /api/records Authorization: Bearer {token} { bookId: book_xxx, contactId: contact_xxx, type: receive, amount: 800, date: 2026-06-20, note: 婚礼 }响应{code:0,data:{id:record_xxx,bookId:book_xxx,contactId:contact_xxx,type:receive,amount:800,date:2026-06-20,note:婚礼,createdAt:2026-06-20T10:00:00Z}}六、总结API设计的核心原则资源命名用复数/api/books而不是/api/book使用标准HTTP方法GET/POST/PUT/DELETE状态码语义化用标准HTTP状态码错误信息清晰告诉用户哪里错了、怎么改遵循这些规范API会更容易维护也更容易被前端调用。