一. 什么是RESTful
REST与技术无关,代表的是一种软件架构气势派头,REST是Representational State Transfer的简称,中文翻译为“表征状态转移”
REST从资源的角度类审视整个网络,它将漫衍在网络中某个节点的资源通过URL进行标识,客户端应用通过URL来获取资源的表征,,获得这些表征致使这些应用改变状态
所有的数据,不管是通过网络获取的还是操纵数据库获得(增删改查)的数据,都是资源,将一切数据视为资源是REST区别与其他架构气势派头的最素质属性
对付REST这种面向资源的架构气势派头,有人提出一种全新的布局理念,即:面向资源架构(ROA:Resource Oriented Architecture)
对互联网上的任意对象都视为资源,他认为一个url就是一个资源 好比:
二. 了解什么是API1、什么是API?
答:API就是接口,供给的url。接口有两个用途:
- 为别人供给处事
- 前后端疏散,一个写vue,一个写后端,他们之间都是通过ajax请求
三、RESTful API设计网络应用措施,分为前端和后端两个部分。当前的成长趋势,就是前端设备屡见不鲜(手机、平板、桌面电脑、其他专用设备......)。
因此,必需有一种统一的机制,便利差此外前端设备与后端进行通信。这导致API构架的风行,甚至呈现"API First"的设计思想。RESTful API是目前对照成熟的一套互联网应用措施的API设计理论。
那么先来简单了解一下
1、协议
API与用户的通信协议,总是使用HTTPs协议。
2、域名
有两种方法
方法一: 尽量将API部署在专用域名(会存在跨域问题)
https://api.example.com
方法二:如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下。
https://example.org/api/
3、版本(Versioning)
应该将API的版本号放入URL。
https://api.example.com/v1/
另一种做法是,将版本号放在HTTP头信息中,但不如放入URL便利和直不雅观。给与这种做法。
4、路径(Endpoint)
路径又称"终点"(endpoint),暗示API的具体网址。
在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的"调集"(collection),所以API中的名词也应该使用复数。
举例来说,有一个API供给动物园(zoo)的信息,还包孕各类动物和雇员的信息,则它的路径应该设计成下面这样。
https://api.example.com/v1/zoos https://api.example.com/v1/animals https://api.example.com/v1/employees
5、HTTP动词
对付资源的具体操纵类型,由HTTP动词暗示。
常用的HTTP动词有下面五个(括号里是对应的SQL命令)。
GET(SELECT):从处事器取出资源(一项或多项)。即获取数据 POST(CREATE):在处事器新建一个资源。 即添加数据 PUT(UPDATE):在处事器更新资源(客户端供给转变后的完整资源)。即更新数据 PATCH(UPDATE):在处事器更新资源(客户端供给转变的属性)。即更新数据 DELETE(DELETE):从处事器删除资源 。即删除数据
还有两个不常用的HTTP动词。
HEAD:获取资源的元数据。 OPTIONS:获取信息,关于资源的哪些属性是客户端可以转变的。
下面是一些例子:
GET /zoos:列出所有动物园 POST /zoos:新建一个动物园 GET /zoos/ID:获取某个指定动物园的信息 PUT /zoos/ID:更新某个指定动物园的信息(供给该动物园的全部信息) PATCH /zoos/ID:更新某个指定动物园的信息(供给该动物园的部分信息) DELETE /zoos/ID:删除某个动物园 GET /zoos/ID/animals:列出某个指定动物园的所有动物 DELETE /zoos/ID/animals/ID:删除某个指定动物园的指定动物
6、过滤信息(Filtering)
如果记录数量很多,处事器不成能都将它们返回给用户。API应该供给参数,过滤返回功效。
下面是一些常见的参数。
?limit=10:指定返回记录的数量 ?offset=10:指定返回记录的开始位置。 ?page=2&per_page=100:指定第几页,以及每页的记录数。 ?sortby=name&order=asc:指定返回功效凭据哪个属性排序,以及排序挨次。 ?animal_type_id=1:指定筛选条件
参数的设计允许存在冗余,即允许API路径和URL参数偶尔有反复。好比,GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是不异的。
7、状态码(status codes)
处事器向用户返回的状态码和提示信息,常见的有以下一些(方括号中是该状态码对应的HTTP动词)。
200 OK - [GET]:处事器告成返回用户请求的数据,该操纵是幂等的(Idempotent)。 201 CREATED - [POST/PUT/PATCH]:用户新建或改削数据告成。 202 Accepted - [*]:暗示一个请求已经进入后台排队(异步任务) 204 NO CONTENT - [DELETE]:用户删除数据告成。 400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,处事器没有进行新建或改削数据的操纵,该操纵是幂等的。 401 Unauthorized - [*]:暗示用户没有权限(令牌、用户名、暗码错误)。 403 Forbidden - [*] 暗示用户得到授权(与401错误相对),但是访谒是被禁止的。 404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,处事器没有进行操纵,该操纵是幂等的。 406 Not Acceptable - [GET]:用户请求的格局不成得(好比用户请求JSON格局,但是只有XML格局)。 410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个东西时,产生一个验证错误。 500 INTERNAL SERVER ERROR - [*]:处事器产生错误,用户将无法判断发出的请求是否告成。
状态码的完全列表参见这里。
8、错误措置惩罚惩罚(Error handling)
如果状态码是4xx,就应该向用户返回堕落信息。一般来说,返回的信息中将error作为键名,堕落信息作为键值即可。
{ error: "Invalid API key" }
9、返回功效
针对差别操纵,处事器向用户返回的功效应该切合以下规范