GET 、POST 、PUT 、DELETE ... 的基本含义

  • GET:请求从服务器获取特定资源。
    举个例子:GET /classes(获取所有班级)
  • POST :在服务器上创建一个新的资源。
    举个例子:POST /classes(创建班级)
  • PUT :更新服务器上的资源(客户端提供更新后的整个资源)。
    举个例子:PUT /classes/12(更新编号为 12 的班级)
  • DELETE :从服务器删除特定的资源。
    举个例子:DELETE /classes/12(删除编号为 12 的班级)
  • PATCH :更新服务器上的资源(客户端提供更改的属性,可以看做作是部分更新),使用的比较少,这里就不举例子了。
  • OPTION :由浏览器自动发送,检查请求的一些权限。

Talk is cheap!来举个实际的例子来说明一下吧!现在有这样一个 API 提供班级(class)的信息,还包括班级中的学生和教师的信息,则它的路径应该设计成下面这样:

GET    /classes:列出所有班级
POST   /classes:新建一个班级
GET    /classes/{classId}:获取某个指定班级的信息
PUT    /classes/{classId}:更新某个指定班级的信息(一般倾向整体更新)
PATCH  /classes/{classId}:更新某个指定班级的信息(一般倾向部分更新)
DELETE /classes/{classId}:删除某个班级
GET    /classes/{classId}/teachers:列出某个指定班级的所有老师的信息
GET    /classes/{classId}/students:列出某个指定班级的所有学生的信息
DELETE /classes/{classId}/teachers/{ID}:删除某个指定班级下的指定的老师的信息

反例:

/getAllclasses
/createNewclass
/deleteAllActiveclasses

理清资源的层次结构,比如业务针对的范围是学校,那么学校会是一级资源:/schools,老师:/schools/teachers,学生:/schools/students就是二级资源。

posted @ 2023-03-15 08:53  HopeLive  阅读(189)  评论(0)    收藏  举报