RESTful API 设计指南

 

网应用程序,分为前端和后端两只有。当前底发展趋势,就是前者设备层出不穷(手机、平板、桌面电脑、其他专用设备……)。

于是,必须产生平等栽统一之体制,方便不同之前端设备与后端进行通信。这招API构架的风靡,甚至出现”API
First”的设计思想。RESTful
API是当前于成熟之等同仿照互联网应用程序的API设计理论。我以前写过一样首《理解RESTful架构》,探讨如何知道这个定义。

今,我拿介绍RESTful
API的筹划细节,探讨如何规划相同模拟合理、好用底API。我的首要参考了区区篇文章(1,2)。

图片 1

一、协议

API与用户之通信协议,总是以HTTPs协议。

二、域名

应当尽可能将API部署于专用域名之下。

https://api.example.com

一经确定API很粗略,不见面生更加扩展,可以设想在主域名下。

https://example.org/api/

三、版本(Versioning)

应当用API的版本号放入URL。

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

另外一样种做法是,将版本号放在HTTP头信息遭到,但不苟放入URL方便及直观。Github运这种做法。

四、路径(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

五、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路径和URL参数偶尔发再。比如,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:返回一个空文档

十、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”
}

地方代码表示,服务器被有了提示信息,以及文档的网址。

十一、其他

(1)API的身价认证应用OAuth
2.0框架。

(2)服务器返回的数额格式,应该尽可能使JSON,避免采取XML。

(完)

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

 

相关文章

网站地图xml地图