⑧ 、错误处理(Error handling)

设若状态码是4xx,就相应向用户重回出错音信。一般的话,重回的信息中校error作为键名,出错音讯作为键值即可。

{
error: “Invalid API key”
}

 

二、域名

应当尽大概将API陈设在专用域名之下。

https://api.example.com

比方分明API相当的粗略,不会有更为壮大,可以设想放在主域名下。

https://example.org/api/

十、Hypermedia API

RESTful
API最好成功Hypermedia,即重返结果中提供链接,连向其余API方法,使得用户不查文书档案,也领会下一步应该做如何。

诸如,当用户向api.example.com的根目录发出请求,会赢得这么三个文书档案。

{“link”: {
“rel”: “collection https://www.example.com/zoos“,
“href”: “https://api.example.com/zoos“,
“title”: “List of zoos”,
“type”: “application/vnd.yourformat+json”
}}

下面代码表示,文书档案中有二个link属性,用户读取那本性格就掌握下一步该调用什么API了。rel表示这几个API与当下网址的涉嫌(collection关系,并交给该collection的网址),href代表API的途径,title表示API的标题,type表示回去类型。

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
}

上边代码表示,服务器交由了提醒音讯,以及文书档案的网址。

陆 、过滤新闻(Filtering)

只要记录数据过多,服务器不容许都将它们再次来到给用户。API应该提供参数,过滤重返结果。

上面是有的科学普及的参数。

  • ?limit=10:内定重返记录的多少
  • ?offset=10:钦赐再次回到记录的上马地方。
  • ?page=2&per_page=100:内定第几页,以及每页的记录数。
  • ?sortby=name&order=asc:钦命重临结果按照哪个属性排序,以及排序依次。
  • ?animal_type_id=1:钦点筛选标准

参数的宏图允许存在冗余,即允许API路径和UCRUISERL参数偶尔有再度。比如,GET
/zoo/ID/animals 与 GET /animals?zoo_id=ID 的意义是相同的。

转自:http://www.ruanyifeng.com/blog/2014/05/restful\_api.html

 

四、路径(Endpoint)

途径又称”终点”(endpoint),表示API的切实网址。

在RESTful架构中,每种网址代表一种财富(resource),所以网址中不能够有动词,只好著名词,而且所用的名词往往与数据库的表格名对应。一般的话,数据库中的表都以同种记录的”集合”(collection),所以API中的名词也应有选用复数。

举例来说来说,有2个API提供动物园(zoo)的信息,还包罗各类动物和雇员的音信,则它的路径应该设计成上边那样。

三、版本(Versioning)

应该将API的版本号放入ULANDL。

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

另一种做法是,将版本号放在HTTP头消息中,但不如放入ULANDL方便和直观。Github利用那种做法。

九 、重临结果

本着差异操作,服务器向用户再次回到的结果应该符合以下标准。

  • GET /collection:再次来到能源对象的列表(数组)
  • GET /collection/resource:再次回到单个财富对象
  • POST /collection:再次来到新生成的能源对象
  • PUT /collection/resource:再次来到完整的财富对象
  • PATCH /collection/resource:再次回到完整的能源对象
  • DELETE /collection/resource:重回多个空文书档案

五、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:删除有些钦命动物园的钦命动物

一、协议

API与用户的通讯协议,总是选取HTTPs协议

RESTful API 设计指南

 

网络应用程序,分为前端和后端多个部分。当前的发展趋势,就是前者设备不以为奇(手提式有线电话机、平板、桌面电脑、其余专用设备……)。

就此,必须有一种统一的编写制定,方便分裂的前端设备与后端实行通讯。那致使API构架的风靡,甚至出现“API
First”
的设计思想。RESTful
API
是现阶段比较早熟的一套互连网应用程序的API设计理论。小编此前写过一篇《理解RESTful架构》,研讨如何掌握这几个定义。

前些天,小编将介绍RESTful
API的统一筹划细节,钻探怎么着布署一套合理、好用的API。笔者的显要参照了两篇小说(12)。

XML 1

十一、其他

(1)API的地方认证应该运用OAuth
2.0
框架。

(2)服务器重回的数额格式,应该尽只怕使用JSON,幸免采纳XML。

(完)

七、状态码(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 –
    [*]:服务器发生错误,用户将不能够判定爆发的央浼是还是不是成功。

状态码的完全列表参见这里

相关文章

网站地图xml地图