RESTful API设计规范与最佳实践

RESTful API设计规范

一、URL设计

• 使用名词复数：/api/users、/api/articles
• 嵌套资源：/api/users/1/articles
• 查询参数：/api/articles?page=1&limit=10
• 避免动词：用HTTP方法表达操作

二、HTTP方法

• GET：查询资源
• POST：创建资源
• PUT：全量更新
• PATCH：部分更新
• DELETE：删除资源

三、状态码

• 200：成功
• 201：创建成功
• 400：请求错误
• 401：未授权
• 404：资源不存在
• 500：服务器错误

四、响应格式

统一格式：{ success: true, data: {}, message: "" }

分页响应需包含pagination信息。

相关文章推荐