RestFul API

最新推荐文章于 2023-05-04 14:25:17 发布

Anvilliu

最新推荐文章于 2023-05-04 14:25:17 发布

阅读量82

点赞数

分类专栏：系统设计文章标签： java restful

本文链接：https://blog.csdn.net/sfjsww66/article/details/112117328

版权

系统设计专栏收录该内容

1 篇文章 0 订阅

订阅专栏

一、概念

REST,即REpresentational State Transfer 的缩写。翻译过来是"表现层状态转化"。其实全称是Resource Representational State Transfer，翻译过来是资源表现状态的转换。

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

综上所述，RESTful架构就是：

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

二、REST 接口规范

1、动作

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

2、路径（接口命名）

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

网址中不能有动词，只能有名词，API 中的名词也应该使用复数。 因为 REST 中的资源往往和数据库中的表对应，而数据库中的表都是同种记录的"集合"（collection）。如果 API 调用并不涉及资源（如计算，翻译等操作）的话，可以用动词。 比如：GET /calculate?param1=11&param2=33
不用大写字母，建议用中杠 - 不用下杠 _ 比如邀请码写成 invitation-code

接口尽量使用名词，禁止使用动词。 下面是一些例子：

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、过滤信息（Filtering）

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

GET    /classes?state=active&name=guidegege

比如我们要实现分页查询：

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

4、状态码（Status Codes）

状态码范围：

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

三 HATEOAS

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

上面是 RESTful API 最基本的东西，也是我们平时开发过程中最容易实践到的。实际上，RESTful API 最好做到 Hypermedia，即返回结果中提供链接，连向其他 API 方法，使得用户不查文档，也知道下一步应该做什么。

比如，当用户向 api.example.com 的根目录发出请求，会得到这样一个文档。

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

上面代码表示，文档中有一个 link 属性，用户读取这个属性就知道下一步该调用什么 API 了。rel 表示这个 API 与当前网址的关系（collection 关系，并给出该 collection 的网址），href 表示 API 的路径，title 表示 API 的标题，type 表示返回类型 Hypermedia API 的设计被称为HATEOAS。

在 Spring 中有一个叫做 HATEOAS 的 API 库，通过它我们可以更轻松的创建除符合 HATEOAS 设计的 API。

参考：JavaGuide，RestFul简明教程

Anvilliu

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
RestFul API

一、概念REST,即REpresentational State Transfer 的缩写。翻译过来是"表现层状态转化"。其实全称是Resource Representational State Transfer，翻译过来是资源表现状态的转换。资源（Resource）：我们可以把真实的对象数据称为资源。一个资源既可以是一个集合，也可以是单个个体。比如我们的班级 classes 是代表一个集合形式的资源，而特定的 class 代表单个个体资源。每一种资源都有特定的 URI（统一资源定位符）与之对应
复制链接

扫一扫