批量操作的倒置
往往有这样一种情况,用户需要对列表页的多行记录进行批量操作,如果要求前端逐个向后端请求既不能保证操作的一致性(虽然批量操作时后端也未必能保证事务),也在查看操作日志时产生困惑。所以尽量一次请求,那么api怎么设计呢,下面以给多个学员分配一个老师为例(一个学员只能有一个老师,而一个老师可以有多个学生)
soap
一种容易设计出来的方式是soap风格
{
"teacherId":"老师",
"studentIds":["学生1","学生2"]
}
这种情况下就和url来锁定resource不相符了。如果是restful风格如何处理呢
原语义
PUT /api/student?id=学生1&id=学生2
{"teacherId":"老师"}
这种情况id在?后面,有点和restful感觉不一样
倒置
PUT/PATCH /api/teacher/001
{"studentIds":["学员1","学员2"]}
至于使用PUT还是PATCH取决于语义,是替换这个老师的学员还是给这个老师增加学员
关键信息的倒置
例如需要向一个部门里添加员工,业务要求是没有禁用的部门才能添加员工.所以这个时候部门的状态就是业务操作的约束条件
原语义
POST /staff
{"organizationId":1,"name":"zhang san"}
倒置
POST /organization/1/staff
{"name":"zhang san"}
这样的话就把语义转换为对部门新增员工,缺点是无法区分新增员工还是转移员工