来自 威尼斯国际官方网站 2019-09-11 14:53 的文章
当前位置: 威尼斯国际官方网站 > 威尼斯国际官方网站 > 正文

RESTful API

  • REST与才具无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,普通话翻译为“特色状态转移
  • REST从能源的角度类审视整个互连网,它将布满在互连网中有个别节点的能源通过UQashqaiL实行标记,顾客端应用通过U索罗德L来赢得财富的风味,获得那几个特色致使那个使用调换状态
  • 负有的数码,不管是由此网络获得的要么操作数据库获得(增删改查)的数额,都是财富,将整个数据正是能源是REST差异与其余架构风格的最本质属性
  • 威尼斯国际官方网站 ,对此REST这种面向资源的架构风格,有人提议一种全新的布局观念,即:面向资源架构(ROA:Resource Oriented Architecture)
    • 对互联网络的率性东西都视为能源,他以为四个url正是两个财富举例:

RESTful API,restfulapi

  • REST与技艺非亲非故,代表的是一种软件框架结构风格,REST是Representational State Transfer的简称,汉译为“特色状态转移
  • REST从能源的角度类审视整个互联网,它将布满在互联网中某些节点的能源通过U汉兰达L进行标志,顾客端应用通过URL来获得能源的特点,获得那几个特点致使这几个使用转换状态
  • 抱有的数据,不管是因而网络获取的照旧操作数据库获得(增加和删除改查)的数量,都是财富,将全部数据正是财富是REST区别与其他架构风格的最本质属性
  • 对此REST这种面向财富的架构风格,有人建议一种全新的协会观念,即:面向能源架构(ROA:Resource Oriented Architecture)
    • 对网络络的随机东西都视为能源,他以为贰个url就是贰个资源例如:

1、什么是API?

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

  • - 为外人提供服务
  • - 前后端分离,二个写vue,贰个写后端,他们中间都是透过ajax诉求

网络应用程序,分为前端和后端多个部分。当前的发展趋势,就是前者设备见怪不怪(手机、平板、桌面计算机、别的专项使用设备......)。

为此,必得有一种统一的建制,方便差异的前端设备与后端进行通信。那产生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的版本号放入U奥迪Q3L。

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

另一种做法是,将版本号放在HTTP头新闻中,但比不上放入U昂科威L方便和直观。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路线和U福特ExplorerL参数不经常有重新。比方,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的版本号归入U翼虎L。

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

另一种做法是,将版本号放在HTTP头新闻中,但不比放入UCR-VL方便和直观。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模式:

 

本文由威尼斯国际官方网站发布于威尼斯国际官方网站,转载请注明出处:RESTful API

关键词: