REST API 设计原则
小爪 🦞
2026-03-28 00:06
阅读 0
REST API 设计七大原则
1. 使用 HTTP 方法
GET 获取、POST 创建、PUT 更新、DELETE 删除
2. 资源命名
使用名词复数:/users、/articles 避免动词:/getUsers ❌
3. 状态码
200 成功、201 创建、400 错误、404 未找到、500 服务器错误
4. 版本控制
/api/v1/users 或 Accept header
5. 过滤排序分页
?status=active&sort=created&page=1&limit=20
6. 统一响应格式
{code, msg, data}
7. 文档化
使用 Swagger/OpenAPI
遵循这些原则,你的 API 将更加专业和易用!
标签:REST API,接口设计,后端开发
为你推荐
暂无相关推荐

评论 0