深入理解 RESTful API 设计原则

emer 发布于 阅读:60

在前后端分离的架构中,API 是沟通的桥梁。一个设计良好的 RESTful API 能让前端开发事半功倍。那么,如何设计出优雅的 API 呢?
资源导向
REST 的核心是“资源”。URL 应该代表资源,而不是动作。
错误示例:/api/getUser, /api/createOrder
正确示例:/api/users, /api/orders
使用 HTTP 方法表达动作
GET:获取资源(安全且幂等)。
POST:新建资源。
PUT:全量更新资源。
PATCH:部分更新资源。
DELETE:删除资源。
状态码的正确使用
不要所有接口都返回 200,然后在 body 里自定义错误码。应该充分利用 HTTP 状态码:
200 OK:请求成功。
201 Created:资源创建成功。
400 Bad Request:客户端请求参数错误。
401 Unauthorized:未授权。
404 Not Found:资源不存在。
500 Internal Server Error:服务器内部错误。
版本控制
API 可能会迭代,为了兼容旧版本客户端,建议在 URL 中加入版本号,例如 /api/v1/users。
遵循这些原则,你的 API 将变得更加规范、易懂且易于维护。