RESTful API 设计指南

 

网络应用程序,分为前端和后端四个部分。当前的发展趋势,就是前者设备见怪不怪(手机、平板、桌面电脑、其余专用设备……)。

因此,必须有一种统一的体制,方便不一致的前端设备与后端进行通讯。那致使API构架的盛行,甚至现身“API
First”
的布署性思想。RESTful
API
是眼下比较早熟的一套互连网应用程序的API设计理论。小编以前写过一篇《理解RESTful架构》,研究怎样了然这么些概念。

前几天,作者将介绍RESTful
API的统筹细节,研究怎么样设计一套合理、好用的API。我的首要参考了两篇小说(12)。

json 1

一、协议

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

二、域名

相应尽量将API安顿在专用域名之下。

https://api.example.com

若是显然API很简短,不会有愈来愈伸张,可以考虑放在主域名下。

https://example.org/api/

三、版本(Versioning)

应当将API的版本号放入U普拉多L。

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

另一种做法是,将版本号放在HTTP头新闻中,但不如放入UEscortL方便和直观。Github接纳那种做法。

四、路径(Endpoint)

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

在RESTful架构中,各种网址代表一种能源(resource),所以网址中无法有动词,只可以盛名词,而且所用的名词往往与数据库的表格名对应。一般的话,数据库中的表都以同种记录的”集合”(collection),所以API中的名词也应当使用复数。

比方来说,有三个API提供动物园(zoo)的音讯,还包罗各类动物和雇员的新闻,则它的门径应该设计成上面那样。

五、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:删除有个别指定动物园的内定动物

⑥ 、过滤音讯(Filtering)

如果记录数据过多,服务器不大概都将它们重临给用户。API应该提供参数,过滤重临结果。

下边是部分宽广的参数。

  • ?limit=10:内定再次回到记录的数量
  • ?offset=10:内定再次回到记录的启幕地方。
  • ?page=2&per_page=100:内定第几页,以及每页的记录数。
  • ?sortby=name&order=asc:内定再次来到结果根据哪个属性排序,以及排序依次。
  • ?animal_type_id=1:指定筛选标准

参数的安顿性允许存在冗余,即允许API路径和U索罗德L参数偶尔有再次。比如,GET
/zoo/ID/animals 与 GET /animals?zoo_id=ID 的意义是一样的。

七、状态码(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 –
    [*]:服务器暴发错误,用户将不恐怕看清发生的央求是不是中标。

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

八 、错误处理(Error handling)

如若状态码是4xx,就活该向用户重临出错消息。一般的话,再次回到的音讯上将error作为键名,出错新闻作为键值即可。

{
error: “Invalid API key”
}

九 、再次回到结果

本着不相同操作,服务器向用户重回的结果应该符合以下标准。

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

json,十、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会获取2个具备可用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
}

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

十一、其他

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

(2)服务器重临的数据格式,应该尽或者利用JSON,幸免采用XML。

(完)

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

 

相关文章

网站地图xml地图