SSM 实战项目①丨图书管理系统 丨技术储备丨(2)RESTful API 接口设计总结
本篇隶属于《SSM 实战项目①丨图书管理系统 》
1. REST
简而言之,REST 指的是一组架构约束条件和原则。满足这些约束条件和原则的应用程序或设计就是 RESTful。
2. RESTful 风格
所谓 RESTful 风格其实就是利用客户端与服务端之前请求方式的不同(如:POST,DELETE,PUT和GET)来区分不同的接口,从而使接口名称更加简约、更易扩展。
3. RESTful 风格特点
-
每一个URI代表1种资源;
-
客户端使用GET、POST、PUT、DELETE4个表示操作方式的动词对服务端资源进行操作:GET用来获取资源,POST用来新建资源(也可以用于更新资源),PUT用来更新资源,DELETE用来删除资源;
-
通过操作资源的表现形式来操作资源;
-
资源的表现形式是XML或者HTML;
-
客户端与服务端之间的交互在请求之间是无状态的,从客户端到服务端的每个请求都必须包含理解请求所必需的信息。
4. RESTful API 举例
- 单层结构
接口名称 | 请求方式 | 解释 |
---|---|---|
/emp/{id} | GET | 根据id查询员工信息 |
/emp/{id} | PUT | 修改id={id}的员工信息 |
/emp/{id} | DELETE | 删除id={id}的员工信息 |
/emps | GET | 查询所有员工信息 |
/emp | POST | 新增员工 |
- 多层结构
接口名称 | 请求方式 | 解释 |
---|---|---|
/dept/{deptId}/emp/{id} | GET | 查询指定部门的指定员工的信息 |
参考资料:
百度百科:RESTful