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):“资源"是一种信息实体,它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式比如
json
,xml
,image
,txt
等等叫做它的"表现层/表现形式”。 - 状态转移(State Transfer) :大家第一眼看到这个词语一定会很懵逼?内心 BB:这尼玛是啥啊? 大白话来说 REST 中的状态转移更多地描述的服务器端资源的状态,比如你通过增删改查(通过 HTTP 动词实现)引起资源状态的改变。ps:互联网通信协议 HTTP 协议,是一个无状态协议,所有的资源状态都保存在服务器端。
综合上面的解释,我们总结一下什么是 RESTful 架构:
- 每一个 URI 代表一种资源;
- 客户端和服务器之间,传递这种资源的某种表现形式比如
json
,xml
,image
,txt
等等; - 客户端通过特定的 HTTP 动词,对服务器端资源进行操作,实现"表现层状态转化"。
RESTful API 规范
动作
GET
:请求从服务器获取特定资源。举个例子:GET /classes
(获取所有班级)POST
:在服务器上创建一个新的资源。举个例子:POST /classes
(创建班级)PUT
:更新服务器上的资源(客户端提供更新后的整个资源)。举个例子:PUT /classes/12
(更新编号为 12 的班级)DELETE
:从服务器删除特定的资源。举个例子:DELETE /classes/12
(删除编号为 12 的班级)PATCH
:更新服务器上的资源(客户端提供更改的属性,可以看做作是部分更新),使用的比较少,这里就不举例子了。
路径(接口命名)
路径又称"终点"(endpoint),表示 API 的具体网址。实际开发中常见的规范如下:
- 网址中不能有动词,只能有名词,API 中的名词也应该使用复数。 因为 REST 中的资源往往和数据库中的表对应,而数据库中的表都是同种记录的"集合"(collection)。如果 API 调用并不涉及资源(如计算,翻译等操作)的话,可以用动词。比如:
GET /calculate?param1=11¶m2=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
就是二级资源。
过滤信息(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 请求方法不对 |
RESTful的意义及其使用规则相关推荐
- 第一节:WebApi的纯原生态的RestFul风格接口和路由规则介绍
一. 原生态接口 1. 从默认路由开始分析 在WebApiConfig.cs类中的Register方法中,我们可以看到默认路由如下: 分析:请求地址在 controller 前面需要加上 api/,c ...
- 从消费者角度评估RestFul的意义
相关博文: 从消费者角度评估RestFul的意义 SpringBoot 构建RestFul API 含单元测试 REST是目前业界相当火热的术语,似乎发布的API不带个REST前缀,你都不好意思和别人 ...
- 《部落与弯刀》,我的第一个真正意义上的规则驱动开放世界游戏,快做完了
[国产PC单机独立游戏]开放世界.沙漠幻想题材,<部落与弯刀>--即将上线steam EA 趟了不少坑,想明白许多问题. 做游戏的过程也是对世界和对自己认知的过程.
- 花5分钟看这篇之前,你才发现你不懂RESTful
前言 在学习RESTful 风格接口之前,即使你不知道它是什么,但你肯定会好奇它能解决什么问题?有什么应用场景?听完下面描述我想你就会明白: 在互联网并没有完全流行的初期,移动端也没有那么盛行,页面请 ...
- 数据蒋堂 | JOIN简化 - 意义总结
来源:数据蒋堂 作者:蒋步星 本文长度为3000字,建议阅读6分钟 本文为你讲解SQL中用于多表关联的JOIN运算的简化--意义总结. 我们重新审视和定义了等值JOIN运算,并简化了语法.一个直接的效 ...
- 因果解释能够对规则进行解释吗?
来源:<哲学动态>2017年第10期 作者:初维峰(西安交通大学人文社会科学学院) 本文受中国博士后科学基金面上资助项目"当代西方因果解释理论研究"(2017M6131 ...
- FPGA之道(39)HDL的命名规则
文章目录 前言 命名规则 命名要有意义 简单意义命名 复杂意义命名 一.下划线分隔法. 二.非首单词首字母大写分隔法. 多重相似命名 电平敏感命名 方向敏感命名 命名格式要统一 命名格式要区分 前言 ...
- 花五分钟看这篇之前,你才发现你不懂RESTful
原创公众号(希望能支持一下):bigsai 转载请联系bigsai 文章收藏在回车课堂 和github 前言 在学习RESTful 风格接口之前,即使你不知道它是什么,但你肯定会好奇它能解决什么问题? ...
- android intent-filter作用,Android中Intent-Filter的匹配规则是什么
Android中Intent-Filter的匹配规则是什么 发布时间:2020-12-14 15:19:32 来源:亿速云 阅读:67 作者:Leah 今天就跟大家聊聊有关Android中Intent ...
最新文章
- node上传资源到又拍云
- ZooKeeper配置中出现Error contacting service. It is probably not running
- ECharts x时间轴不连续实现
- android调用文件管理打开某个路径,安卓 通过intent调用系统文件管理器打开指定路径目录...
- 信息系统项目管理知识--软件工程
- 【产品]如何建立交互设计自查表
- MVC 自定义分面控件
- Express — 使用步骤
- java常用序列化与反序列化方法
- 利用动态图层实现数据的实时显示
- canvas系列 — canvas常用API介绍
- 程序员爱穿格子衫、秃头的刻板印象是如何形成的?
- 信息安全:需求进一步升级 行业再上风口
- 网友发帖曝最剽悍翻译 贵阳译成昂贵的太阳
- Sematic-UI安装方法:
- 12306抢票软件相关接口以及数据格式
- 探究腾讯云TCA和阿里acp的区别
- KONG (API网关) 用CORS处理跨域,针对:非简单请求
- 调整变速器后拨详细图文教程
- oracle rac 宕机频繁,Oracle rac宕机分析故障处理
热门文章
- AS--Location specified by ndk.dir...
- java饭堂管理代码论文_[计算机设计精品] 基于java的餐饮管理系统(毕业论文).doc...
- 省市区sql语句之:(三)区2
- avoscloud赞助之hackathon大会
- 【测试视频】信号源单边带相位噪声SSB测试
- emu0404 PCI 声卡在银河麒麟下成功发声
- R绘制中国地图,并展示流行病学数据
- c++常用函数所在头文件一览
- 水木清华100个爆笑签名
- html 城市选择,城市选择