RESTful API
RESTful API 是一种基于 HTTP 协议的应用程序接口设计风格,其核心思想是将网络中的资源抽象为 URL,通过标准 HTTP 方法对资源进行操作。以下是其关键特性和设计原则:
一、核心设计理念
资源导向
使用名词性 URL 标识资源(如
/users
),避免动词每个资源通过唯一 URI 定位,例如
/articles/456
表示 ID 为 456 的文章HTTP 方法语义化
GET 查询资源 获取用户列表 POST 创建资源 新增订单 PUT 全量更新 修改产品全部属性 PATCH 部分更新 仅更新用户手机号 DELETE 删除资源 移除某条评论 其中 PUT 与 PATCH 的区别在于前者需提交完整资源数据,后者仅需变更字段
二、架构原则
无状态性
每个请求必须包含处理所需的所有信息,服务器不保存客户端会话状态统一接口
通过标准 HTTP 状态码(如 200/404)和 JSON/XML 数据格式交互
支持 HATEOAS(超媒体作为应用状态引擎),在响应中包含可操作链接
版本控制
建议通过 URL(如/v1/users
)或请求头实现 API 版本管理,确保兼容性
三、实际应用建议
非资源型操作:如登录、统计等场景可突破严格 REST 约束,直接使用
/login
等动词路径错误处理:除 HTTP 状态码外,可自定义业务错误码体系(如
{ "code": 1001, "msg": "余额不足" }
)性能优化:支持过滤(
/users?age=18
)、分页(/posts?page=2
)等参数设计