RESTful API,restfulapi

  • REST与手艺无关,代表的是一种软件架构风格,REST是Representational
    State Transfer的简称,普通话翻译为“天性状态转移
  • REST从能源的角度类审视整个互联网,它将遍及在互联网中某些节点的能源通过U传祺L进行标志,客商端应用通过UHavalL来收获财富的性状,获得那么些特征致使那个使用调换状态
  • 具备的多寡,不管是由此网络获取的也许操作数据库获得(增加和删除改查)的数据,都以财富,将整体数据正是财富是REST差别与任何架构风格的最本质属性
  • 对此REST这种面向财富的架构风格,有人建议一种全新的布局理念,即:面向能源架构(ROA:Resource
    Oriented Architecture)

    • 对互连网络的轻松东西都视为能源,他以为贰个url就是叁个能源举例:

RESTful API,restfulapi

  • REST与技能非亲非故,代表的是一种软件架构风格,REST是Representational
    State Transfer的简称,中文翻译为“特征状态转移
  • REST从财富的角度类审视整个网络,它将分布在网络中有个别节点的资源通过UENCOREL实行标记,客户端应用通过ULacrosseL来获取能源的风味,获得那些特点致使那么些应用转换状态
  • 有着的数额,不管是通过互连网得到的恐怕操作数据库获得(增加和删除改查)的多少,都以财富,将总体数据正是能源是REST分歧与其余架构风格的最本质属性
  • 对于REST这种面向财富的架构风格,有人建议一种全新的布局观念,即:面向财富架构(ROA:Resource
    Oriented Architecture)

    • 对互联英特网的自由东西都说是财富,他以为二个url正是三个能源举例:

1、什么是API?

答:API就是接口,提供的url。接口有七个用途:

  • – 为别人提供服务
  • – 前后端分离,多少个写vue,三个写后端,他们中间都以因此ajax央求

互连网应用程序,分为前端和后端多少个部分。当前的发展趋势,便是前面一个设备熟视无睹(手提式有线电话机、平板、桌面Computer、别的专项使用设备……)。

故此,必须有一种统一的编写制定,方便差异的前端设备与后端实行通讯。那造成API构架的流行,以至出现”API
First”的设计观念。RESTful
API是时下可比早熟的一套网络应用程序的API设计理论。

那正是说先来大约询问一下

1、什么是API?

1、协议

API与客商的通信合同,总是利用HTTPs合同。

答:API正是接口,提供的url。接口有多个用途:

2、域名

有两种艺术

艺术一: 尽量将API陈设在专项使用域名(会设有跨域难题)

https://api.example.com

办法二:若是分明API非常粗略,不会有更加的扩张,可以考虑放在主域名下。

https://example.org/api/
  • – 为人家提供劳动
  • – 前后端分离,三个写vue,四个写后端,他们之间都以由此ajax央求

3、版本(Versioning)

应当将API的版本号放入UENVISIONL。

https://api.example.com/v1/

另一种做法是,将版本号放在HTTP头消息中,但比不上归入ULANDL方便和直观。Github选择这种做法。

互连网应用程序,分为前端和后端五个部分。当前的发展趋势,正是前面二个设备见怪不怪(手提式有线电话机、平板、桌面计算机、其余专项使用设备……)。

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

故而,必需有一种统一的建制,方便不相同的前端设备与后端举行通讯。那导致API构架的风靡,以至出现”API
First”的策画观念。RESTful
API是当前相比成熟的一套互连网应用程序的API设计理论。

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路线和ULacrosseL参数有时有重新。比方,GET
/zoo/ID/animals 与 GET /animals?zoo_id=ID 的意思是一律的。

1、协议

API与客户的通信公约,总是利用HTTPs协议。

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 - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

状态码的通通列表参见这里。

2、域名

有二种格局

方式一: 尽量将API铺排在专项使用域名(会设有跨域难题)

https://api.example.com

措施二:如若分明API很简短,不会有更为扩张,可以思量放在主域名下。

https://example.org/api/

8、错误处理(Error handling)

假若状态码是4xx,就应该向顾客重临出错消息。一般的话,再次来到的音信中校error作为键名,出错消息作为键值就能够。

{
    error: "Invalid API key"
}

3、版本(Versioning)

应当将API的版本号归入UOdysseyL。

https://api.example.com/v1/

另一种做法是,将版本号放在HTTP头音讯中,但不比放入USportageL方便和直观。Github使用这种做法。

9、再次来到结果

针对分化操作,服务器向客商重返的结果应该符合以下标准

GET /collection:返回资源对象的列表(数组)
GET /collection/resource:返回单个资源对象
POST /collection:返回新生成的资源对象
PUT /collection/resource:返回完整的资源对象
PATCH /collection/resource:返回完整的资源对象
DELETE /collection/resource:返回一个空文档

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

10、Hypermedia API  超媒体API

RESTful
API最棒达成Hypermedia,即重返结果中提供链接,连向任何API方法,使得客商不查文书档案,也通晓下一步应该做怎么着。

例如说,当顾客向api.example.com的根目录发出央浼,会获取如此贰个文书档案。

{"link": {
  "rel":   "collection https://www.example.com/zoos",  #表示这个API与当前网址的关系(collection关系,并给出该collection的网址)
  "href":  "https://api.example.com/zoos",  #API路径
  "title": "List of zoos",  #API的标题
  "type":  "application/vnd.yourformat+json"  #返回类型
}}

Hypermedia
API的宏图被称为HATEOAS。Github的API正是这种布署,访问api.github.com会获得贰个有所可用API的网站列表。

{
  "current_user_url": "https://api.github.com/user",
  "authorizations_url": "https://api.github.com/authorizations",
  // ...
}

从上边能够看来,尽管想博妥当前客商的音讯,应该去做客api.github.com/user,然后就拿走了上边结果。

{
  "message": "Requires authentication",
  "documentation_url": "https://developer.github.com/v3"
}

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:删除某个指定动物园的指定动物

方式一:FBV模式:

 

发表评论

电子邮件地址不会被公开。 必填项已用*标注