课程8：RESTful风格API接口
2026-10-25 20:09:16
RESTful是一种基于Representational State Transfer（表现层状态转移）的软件设计风格，通过URL定位资源、HTTP动词描述操作，使API设计更清晰、简洁、有层次且易于维护。
一、RESTful与传统API的对比传统风格API传统API通常通过URL路径直接描述操作，例如：
获取单个用户：/User/GetUser
获取用户列表：/User/GetList 或 /User/GetUsers
更新用户：/User/UpdateUser
删除用户：/User/DeleteUser接口文档需明确说明URL地址、请求方式（GET/POST）、参数、返回格式（JSON/XML/Text）等信息。
传统API通过路径和动词直接绑定操作，功能可实现但缺乏统一规范。
RESTful风格APIRESTful通过资源定位和HTTP方法（GET/POST/PUT/DELETE）描述操作，例如：
获取单个用户：GET /api/users/{id}
获取用户列表：GET /api/users
更新用户：PUT /api/users/{id}
删除用户：DELETE /api/users/{id}优势：
统一性：资源通过URI定位，操作通过HTTP方法区分，减少路径拼接的复杂性。
可维护性：符合HTTP协议原生语义，便于开发者理解和扩展。
灵活性：通过请求头（Accept/Content-Type）动态指定返回格式，而非硬编码在URL中。
- 核心概念：系统中的实体（如用户、角色、权限）均视为资源，每个资源有唯一URI。
- 操作绑定：对资源的增删改查通过HTTP方法实现：
添加用户：POST /api/users
删除用户：DELETE /api/users/{id}
分配角色：POST /api/users/{id}/roles资源URI应使用名词复数形式（如/users），避免动词（如/getUser）。
- 返回格式：通过HTTP请求头指定，而非URL参数：
Accept: application/json：请求返回JSON格式。
Content-Type: application/xml：声明响应体为XML格式。
- 对比传统方式：
传统：/api/users?type=json
RESTful：GET /api/users + Accept: application/json优势：解耦资源定位与格式协商，符合HTTP协议设计初衷。
- 操作语义化：HTTP方法直接对应资源状态变化：
GET：获取资源状态（安全、幂等）。
POST：创建资源（非幂等）。
PUT：更新完整资源（幂等）。
PATCH：部分更新资源（非幂等）。
DELETE：删除资源（幂等）。
- 幂等性：同一请求多次执行结果一致（如PUT /api/users/1多次调用仅更新一次数据）。
- 规范化开发：统一团队API设计标准，减少沟通成本。
- 前后端分离：通过HTTP协议原生支持，便于前端独立开发。
- 扩展性：资源层级设计（如/api/users/{id}/orders）支持复杂业务场景。
- 兼容性：与HTTP缓存、认证机制（如JWT）无缝集成。
总结：RESTful通过资源定位、HTTP方法语义化和请求头协商，构建了清晰、可扩展的API设计范式。尽管非强制标准，但其优势使其成为现代Web开发的主流选择。
热门标签
