RestFul API 详解

news2024/12/24 8:40:38

一、RestFul API 概述

1.1 API

API（Application Programming Interface）翻译过来是应用程序编程接口的意思。我们在进行后端开发的时候，主要的工作就是为前端或者其他后端服务提供 API 比如查询用户数据的 API 。但是， API 不仅仅代表后端系统暴露的接口，像框架中提供的方法也属于 API 的范畴。

1.2 RestFul API

RESTful API 经常也被叫做 REST API，它是基于 REST 构建的 API。RESTful API 可以让你看到 URL+Http Method 就知道这个 URL 是干什么的，让你看到了 HTTP 状态码（status code）就知道请求结果如何。
在这里插入图片描述

举个例子，如果我给你下面两个 API 你是不是立马能知道它们是干什么用的！

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

在开发过程中设计 API 的时候也应该至少要满足 RESTful API 的最基本的要求（比如接口中尽量使用名词，使用 POST 请求创建资源，DELETE 请求删除资源等等，示例：GET /notes/id：获取某个指定 id 的笔记的信息）。

二、REST概述

REST 是 Representational State Transfer 的缩写，这个词组的翻译过来就是“表现层状态转化”。这样理解起来甚是晦涩，实际上 REST 的全称是 Resource Representational State Transfer ，直白地翻译过来就是 “资源”在网络传输中以某种“表现形式”进行“状态转移” 。

为了更好地理解，解释一下下面几个该奶奶：

资源（Resource）：我们可以把真实的对象数据称为资源。一个资源既可以是一个集合，也可以是单个个体。比如我们的班级 peoples 是代表一个集合形式的资源，而特定的 people代表单个个体资源。每一种资源都有特定的 URI（统一资源标识符）与之对应，如果我们需要获取这个资源，访问这个 URI 就可以了，比如获取特定的人：/people/12。
表现形式（Representational）：“资源"是一种信息实体，它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式比如 json，xml，image,txt 等等叫做它的"表现层/表现形式”。
状态转移（State Transfer）： REST 中的状态转移更多地描述的服务器端资源的状态，比如你通过增删改查（通过 HTTP 动词实现）引起资源状态的改变。ps:互联网通信协议 HTTP 协议，是一个无状态协议，所有的资源状态都保存在服务器端。

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

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

三、RestFul API 规范

在这里插入图片描述

3.1 动作

GET：请求从服务器获取特定资源。举个例子：GET /users（获取所有用户）
POST：在服务器上创建一个新的资源。举个例子：POST /user（创建用户）
PUT：更新服务器上的资源（客户端提供更新后的整个资源）。举个例子：PUT /user/12（更新编号为 12 的用户）
DELETE：从服务器删除特定的资源。举个例子：DELETE /user/12（删除编号为 12 的用户）
PATCH：更新服务器上的资源（客户端提供更改的属性，可以看做作是部分更新），使用较少。

3.2 路径（接口命名）

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

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

3.3 过滤信息（Filtering）

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

GET    /classes?state=active&name=guides

比如要实现分页查询：

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

3.4 状态码（Status Codes）

状态码范围：

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

四、RESTful 的极致 HATEOAS

RESTful 的极致是 hateoas ，但是这个基本不会在实际项目中用到。

上述内容为 RESTful API 的基本内容，也是平时开发过程中最容易实践到的。实际上，RESTful API 最好做到 Hypermedia，即返回结果中提供链接，连向其他 API 方法，使得用户不查文档，也知道下一步应该做什么。比如，当用户向 api.example.com 的根目录发出请求，会得到这样一个返回结果：

{"link": {
  "rel":   "collection https://www.example.com/users",
  "href":  "https://api.example.com/users",
  "title": "List of users",
  "type":  "application/vnd.yourformat+json"
}}