Restful接口规约
在前后端分离的程序架构下，前后端交互一般是由前端通过
HTTP协议
访问后端提供的
Restful
风格的
API
进行的。在这种场景下，常用的
HTTP方法
主要包括：
GET
、
PUT
、
POST
和
DELETE
。
1. GET
GET
方法用于获取资源详情或者列表，不对资源做变更。其一般使用场景如下：
-
获取某个资源的详情：
/resourceName/{id}
，
Path Variable
中的
id
即为要获取的那个资源的唯一
id
特别的，当要获取当前登录用户的详情时，由于后端的
Security Context
中知道当前用户是谁，所以一般直接使用：
/user
即可。 -
分页获取某种资源列表：
/resourceName/list?page=xxx&size=xxx
page
指当前的页码，
size
指每一页的资源数量，同样的，可以增加其他
Query String
参数以实现例如下拉筛选和模糊查找等功能。
2. PUT
PUT
方法用于新增（添加）某个资源。新增的资源数据一般放在
RequestBody
中提交给后端。
3. POST
POST
方法用于对某个资源进行修改（更新）。需要更新的数据一般放在
RequestBody
中提交给后端。
4. DELETE
DELETE
方法用于删除某个资源。一般用法是：
/resourceName/{id}
，同样的，
Path Variable
中的
id
即为要删除的那个资源的唯一
id
。