RESTful API 笔记整理
每个人的理解不一,这里主要是为了自己方便整理了一下网上的资源并加上了自己的理解,有一些知识点没有扩展,主要是自己还没理解,有空会慢慢补充,或者可以从下面的链接看一下其他人的解释.
欢迎交流!!!!
0. 参考资料(Reference)
1.阮一峰.理解 RESTful 架构
2.阮一峰.RESTful API 设计指南
3.菜鸟教程.RESTful 架构详解
4.moonz-wu.译.好 RESTful API 的设计原则
5.JeffreyLi.RESTful Service API 设计最佳工程实践和常见问题解决方案
6.周梦南.深入理解 RESTful Api 架构
1. 基础知识(Basic)
1.1. 起源(History)
名称:REST(Representational State Transfer)
译名:表现层状态转化
提出人:Roy Thomas Fielding, 2000年的博士论文
1.2. 定义(Definitions)
1.2.1. 核心定义
1.2.1.1. 资源(Resource)
即网络上的一个实体,或者说是网络上的一个具体信息.可以是一段文本,一张图片,或者是一种服务;可以是数据库的一张表一条记录,也可以是抽象的概念.
1.2.1.2. 集合(Collection)
某类资源的聚合体.
1.2.1.3. 终端(EndPoint)
该 API 在 RESTful API 中的资源的访问地址,可简单理解为URL,代表某个具体的资源,或者资源的集合.
1.2.1.4. 动词(Verbs)
RESTful API 使用 HTTP 请求方式(HTTP Method)来表示对资源的操作,常见的有如下:
HTTP方法 | 含义 | 是否幂等 | 描述 |
---|---|---|---|
GET | 获取(SELECT) | 否 | 从服务器获取资源或集合 |
POST | 创建(CREATE) | 是 | 从服务器新建一个资源 |
PUT | 更新(UPDATE) | 否 | 在服务器更新资源(客户端提供更改后的完整资源) |
PATCH | 更新(UPDATE) | 否 | 在服务器更新资源(客户端提供资源更改的属性) |
DELETE | 删除(DELETE) | 否 | 从服务器删除资源 |
1.2.2. 其他补充
1.2.2.1. 幂等(Idempotent)
无边际效应,多次操作(即多次调用同一接口)得到相同的结果.
1.2.2.2. URL段(URL Segment)
在URL里以斜杠分割的内容
2. 概念
2.1. 概述
在对以上的基础定义有一定认知后,我先说一下 RESTful API 的一些结论,再慢慢解释:
URL 段只能为名词(资源或集合);
EndPoint 代表了该资源或集合在服务器的访问地址;
基于(1),对资源或集合的操作只能通过动词(HTTP Method)来实现;
2.2. 表现层(Representation)
资源可以有多种表示形式,资源最终呈现给客户端的形式,即为表现层.
# 举例
图片在服务器段以二进制格式保存,展现到前端时可以是jpg,png甚至是txt
Endpoint只代表资源或集合的实体及其所在的位置,它的具体表现形式,应该是 HTTP 请求头中用 Accept 和 Content-Type 字段指定
2.3. 状态转化(State Transfer)
互联网通信协议HTTP协议,是一个无状态协议(Stateless Protocol),这意味着请求本身不携带任何状态.
2.3.1. 应用状态与资源状态
状态应该区分应用状态和资源状态,客户端负责维护应用状态,而服务端维护资源状态.
2.3.1.1. 资源状态的转移
客户端想要操作服务器的资源状态,必须通过某种手段,而这种手段在 RESTful API 中指的就是上面提到的表示操作方式的动词 HTTP Method.
2.3.1.2. 应用状态的转移
客户端应用状态在服务端提供的超媒体的指引下发生变迁.服务端通过超媒体告诉客户端当前状态有哪些后续状态可以进入.
3. 设计指南
3.1. 协议
3.2. 域名
3.3. 版本化(Versioning)
3.4. 接口设计
3.4.1. 使用复数表示collection,加id表示resource
# 举例
POST /statistics 创建一个统计
GET /statistics 获取统计列表
GET /statistics/1 获取指定统计
PUT /statistics/1 更新指定统计(完整资源)
PATCH /statistics/1 更新指定统计(部分更新)
DELETE /statistics/1 删除指定统计
3.4.2. 表示资源的层级关系
# 举例
GET /statistics/1/data 获取id=1的统计下的所有数据列表
*当子资源可以独立父资源存在时,则也可以通过 /data 进行资源操作
3.5. 过滤(Filtering)
3.5.1. 筛选(Data Filter)
# 举例
GET /statistics?userId=1&createTime=today 返回指定条件的数据(用户id为1,今天创建)
3.5.2. 分页(Paging)
# 举例
GET /statistics?page=1&size=20 返回第一页的20条数据
3.5.3. 排序(Sorting)
# 举例
GET /statistics?order=+userId,-title,-createTime 按照指定排序顺序排序(userId升序,title降序,createTime降序)
3.5.4. 字段选择(Field Selection)
# 举例
GET /statistics?fields=userId,title,fields 返回指定字段(userId,title,fields)
GET /statistics?fields=-userId,-statisticId 排除指定字段(userId,statisticId)
3.5.5. 扩展
# 举例
GET /statistics?expand=userId 扩展指定字段信息(userId)
3.6. 状态码(Status Code)
3.7. 使用HATEOAS
Hypermedia as the Engine of Application State 超媒体作为应用状态的引擎,使客户端可以更方便进行下一步操作
3.8. 认证(Authentication)
3.9. 文档(Documentation)
4. 开发实战
1.[smallnest.最好的8个 Java RESTful 框架]: http://colobu.com/2015/11/15/best-available-java-restful-micro-frameworks/
2.[smallnest.Java RESTful框架的性能比较]: http://colobu.com/2015/11/17/Jax-RS-Performance-Comparison/
RESTful API 笔记整理相关推荐
- 《ASP.NET Core 与 RESTful API 开发实战》-- (第10章)-- 读书笔记
第 10 章 部署 10.1 部署到 IIS ASP.NET Core 应用程序支持部署到 IIS 中,之后它将作为应用程序的反向代理服务器和负载均衡器,向应用程序中转传入的 HTTP 请求 默认情况 ...
- 常用API类方法笔记整理1
常用API类方法笔记整理1 1.文档注释 文档注释是功能级注释,用来说明一个类,一个方法或一个常量的,因此只在上述三个地方使用. 文档注释可以使用java自带的命令javadoc来对这个类生成手册. ...
- RPC 笔记(01)— RPC概念、调用流程、RPC 与 Restful API 区别
1. 基本概念 PRC 远程过程调用 Remote Procedure Call,其就是一个节点请求另外一个节点提供的服务.当两个物理分离的子系统需要建立逻辑上的关联时,RPC 是牵线搭桥的常见技术手 ...
- 网上整理的对于Rest和Restful api的理解
一.什么是Rest? REST不是"rest"这个单词,而是几个单词缩写 -- REpresentational State Transfer 直接翻译:表现层状态转移,但这个翻译 ...
- 网上整理的对于Rest和Restful api的理解 - 那啥快看 - 博客园
一.什么是Rest? REST不是"rest"这个单词,而是几个单词缩写 -- REpresentational State Transfer 直接翻译:表现层状态转移,但这个翻译 ...
- restapi是什么意思_网上整理的对于Rest和Restful api的理解
一.什么是Rest? REST不是"rest"这个单词,而是几个单词缩写 -- REpresentational State Transfer 直接翻译:表现层状态转移,但这个翻译 ...
- Eggjs笔记:RESTful API的设计
关于RESTful API 网络应用程序,分为前端和后端两个部分.当前的发展趋势,就是前端设备层出不穷(手机.平板.桌面电脑.其他专用设备-). 因此,必须有一种统一的机制,方便不同的前端设备与后端进 ...
- 运维开发笔记整理-前后端分离
运维开发笔记整理-前后端分离 作者:尹正杰 版权声明:原创作品,谢绝转载!否则将追究法律责任. 一.为什么要进行前后端分离 1>.pc, app, pad多端适应 2>.SPA开发式的流 ...
- SpringBoot学习笔记整理详细
写在前面:欢迎来到「发奋的小张」的博客.我是小张,一名普通的在校大学生.在学习之余,用博客来记录我学习过程中的点点滴滴,也希望我的博客能够更给同样热爱学习热爱技术的你们带来收获!希望大家多多关照,我们 ...
最新文章
- spring boot 打包jar,jar没有主目录清单
- 黑马程序员——集合框架(二)
- 1.12 接口(Interface)的定义和实现
- 「Python-Pycharm」zipimport.ZipImportError: can‘t decompress data; zlib not available
- exe打包工具哪个最好_一键分发工具哪个最好用?这款30万人都在用,很优秀!...
- 如何成为一名出色的次世代游戏美术师?
- Linux下vim常用操作
- pom报错如何解决(org.apache.maven.archiver.mavenarchiver.getmanifest)
- 如何通过配置tomcat或是web.xml让ie直接下载txt类型的文件
- caffe中Makefile.config配置
- Nacos指南-服务发现:删除服务
- Spring Cloud学习笔记(二)Restful理解及微服务的Restful调用
- 使用 ONLYOFFICE 宏监测空气质量数据
- 联想ThinkPad笔记本Fn键关闭与启用方法
- 调用支付宝转账接口(单笔)
- 直流充电桩和交流充电桩有什么区别?
- vue 获取用户位置 高德_Vue使用高德地图
- 2019年安徽省大学生网络攻防赛赛前培训——Day1
- 《计算机组成原理》— 计算机组成原理(一)
- 哈工大软件构造期末知识点总结
热门文章
- 精密划片机:半导体材料在芯片生产制造过程中的关键性作用
- Vmware虚拟机突然连接不上网络【方案集合】
- matlab lc滤波,基于MATLAB的LC二阶低通滤波网络频域分析
- arduino+旋转编码器
- 计算机网络用户名及密码如何查询,用wifi连接电脑的怎么查看宽带账号密码
- 会声会影html5项目是什么意思,会声会影最牛b的几个版本是哪几个 会声会影2018怎么样...
- Tera - 高性能、可伸缩的结构化数据库
- 西门子DR系统怎么进计算机管理器,西门子Select DR操作规程
- ★一名“标题党”自我修炼的10大技巧
- 数字工厂生产监控可视化决策平台,打造智能制造新时代