RESTful的意义及其使用规则

本文参考

https://javaguide.cn/system-design/basis/RESTfulAPI.html

何为 RESTful API

GET    /classes列出所有班级
POST   /classes新建一个班级

RESTful API 可以让你看到 URL+Http Method 就知道这个 URL 是干什么的让你看到了 HTTP 状态码status code就知道请求结果如何。

解读 REST

REST 是 REpresentational State Transfer 的缩写。这个词组的翻译过来就是“表现层状态转化”。

这样理解起来甚是晦涩实际上 REST 的全称是 Resource Representational State Transfer 直白地翻译过来就是 “资源”在网络传输中以某种“表现形式”进行“状态转移” 。如果还是不能继续理解请继续往下看相信下面的讲解一定能让你理解到底啥是 REST 。

我们分别对上面涉及到的概念进行解读以便加深理解实际上你不需要搞懂下面这些概念也能看懂我下一部分要介绍到的内容。不过为了更好地能跟别人扯扯 “RESTful API”我建议你还是要好好理解一下

• 资源Resource 我们可以把真实的对象数据称为资源。一个资源既可以是一个集合也可以是单个个体。比如我们的班级 classes 是代表一个集合形式的资源而特定的 class 代表单个个体资源。每一种资源都有特定的 URI统一资源标识符与之对应如果我们需要获取这个资源访问这个 URI 就可以了比如获取特定的班级/class/12。另外资源也可以包含子资源比如 /classes/classId/teachers列出某个指定班级的所有老师的信息
• 表现形式Representational“资源"是一种信息实体它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式比如 jsonxmlimage,txt 等等叫做它的"表现层/表现形式”。
• 状态转移State Transfer 大家第一眼看到这个词语一定会很懵逼内心 BB这尼玛是啥啊 大白话来说 REST 中的状态转移更多地描述的服务器端资源的状态比如你通过增删改查通过 HTTP 动词实现引起资源状态的改变。ps:互联网通信协议 HTTP 协议是一个无状态协议所有的资源状态都保存在服务器端。

综合上面的解释我们总结一下什么是 RESTful 架构

1. 每一个 URI 代表一种资源
2. 客户端和服务器之间传递这种资源的某种表现形式比如 jsonxmlimage,txt 等等
3. 客户端通过特定的 HTTP 动词对服务器端资源进行操作实现"表现层状态转化"。

RESTful API 规范

动作

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

路径接口命名

路径又称"终点"endpoint表示 API 的具体网址。实际开发中常见的规范如下

1. 网址中不能有动词只能有名词API 中的名词也应该使用复数。 因为 REST 中的资源往往和数据库中的表对应而数据库中的表都是同种记录的"集合"collection。如果 API 调用并不涉及资源如计算翻译等操作的话可以用动词。比如GET /calculate?param1=11&param2=33 。
2. 不用大写字母建议用中杠 - 不用下杠 _ 。比如邀请码写成 invitation-code而不是 invitation_code 。
3. 善用版本化 API。当我们的 API 发生了重大改变而不兼容前期版本的时候我们可以通过 URL 来实现版本化比如 http://api.example.com/v1、http://apiv1.example.com 。版本不必非要是数字只是数字用的最多日期、季节都可以作为版本标识符项目团队达成共识就可。
4. 接口尽量使用名词避免使用动词。 RESTful API 操作HTTP Method的是资源名词而不是动作动词。

来举个实际的例子来说明一下吧现在有这样一个 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 就是二级资源。

过滤信息Filtering

如果我们在查询的时候需要添加特定条件的话建议使用 url 参数的形式。比如我们要查询 state 状态为 active 并且 name 为 guidegege 的班级

GET    /classes?state=active&name=guidegege

比如我们要实现分页查询

GET    /classes?page=1&size=10 //指定第1页每页10个数据

状态码Status Codes

状态码范围

2xx成功	3xx重定向	4xx客户端错误	5xx服务器错误
200 成功	301 永久重定向	400 错误请求	500 服务器错误
201 创建	304 资源未修改	401 未授权	502 网关错误
		403 禁止访问	504 网关超时
		404 未找到
		405 请求方法不对