RESTful API 设计思考

时间 2019-11-06

原文原文链接

RESTful 是目前最流行的 API 设计规范，用于 Web 数据接口的设计。javascript

它的大原则容易把握，可是细节不容易作对。本文总结 RESTful 的设计细节，介绍如何设计出易于理解和使用的 API。
URL 设计
1.1 动词 + 宾语
RESTful 的核心思想就是，客户端发出的数据操做指令都是"动词 + 宾语"的结构。好比，GET /articles这个命令，GET是动词，/articles是宾语。html

动词一般就是五种 HTTP 方法，对应 CRUD 操做。前端

GET：读取（Read）
POST：新建（Create）
PUT：更新（Update）
PATCH：更新（Update），一般是部分更新
DELETE：删除（Delete）
根据 HTTP 规范，动词一概大写。java

网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其余专用设备......）。git

所以，必须有一种统一的机制，方便不一样的前端设备与后端进行通讯。这致使API构架的流行，甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。github

1. 什么是REST

REST全称是Representational State Transfer，中文意思是表述（编者注：一般译为表征）性状态转移。它首次出如今2000年Roy Fielding的博士论文中，Roy Fielding是HTTP规范的主要编写者之一。他在论文中提到："我这篇文章的写做目的，就是想在符合架构原理的前提下，理解和评估以网络为基础的应用软件的架构设计，获得一个功能强、性能好、适宜通讯的架构。REST指的是一组架构约束条件和原则。" 若是一个架构符合REST的约束条件和原则，咱们就称它为RESTful架构。

REST自己并无创造新的技术、组件或服务，而隐藏在RESTful背后的理念就是使用Web的现有特征和能力，更好地使用现有Web标准中的一些准则和约束。虽然REST自己受Web技术的影响很深，可是理论上REST架构风格并非绑定在HTTP上，只不过目前HTTP是惟一与REST相关的实例。因此咱们这里描述的REST也是经过HTTP实现的REST。

什么是RESTful架构：

每个URI表明一种资源；
客户端和服务器之间，传递这种资源的某种表现层；
客户端经过四个HTTP动词（GET/POST/PUT/DELETE），对服务器端资源进行操做，实现”表现层状态转化”。

URI

要让一个资源能够被识别，须要有个惟一标识，在Web中这个惟一标识就是URI(Uniform Resource Identifier)。 URI既能够当作是资源的地址，也能够当作是资源的名称。若是某些信息没有使用URI来表示，那它就不能算是一个资源，只能算是资源的一些信息而已。URI的设计应该遵循可寻址性原则，具备自描述性，须要在形式上给人以直觉上的关联。

HTTP动词

1. 使用GET、POST、PUT、DELETE这几种请求模式

请求模式也能够说是动做、数据传输方式，一般咱们在web中的form有GET、POST两种，而在HTTP中，存在下发这几种。
GET (选择)：从服务器上获取一个具体的资源或者一个资源列表。
POST （建立）：在服务器上建立一个新的资源。
PUT（更新）：以总体的方式更新服务器上的一个资源。
PATCH （更新）：只更新服务器上一个资源的一个属性。
DELETE（删除）：删除服务器上的一个资源。

今天，我将介绍RESTful API的设计细节，探讨如何设计一套合理、好用的API,web

它要考虑这些方面：协议，域名，版本，路径，http，过滤，状态码，错误处理，返回结果json, 身份认证等数据库

1、协议

API与用户的通讯协议，老是使用HTTPs协议。json

2、域名

应该尽可能将API部署在专用域名之下。后端

https://api.example.com

若是肯定API很简单，不会有进一步扩展，能够考虑放在主域名下。

https://example.org/api/

3、版本（Versioning）

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

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

另外一种作法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。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

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路径和URL参数偶尔有重复。好比，GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。

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

状态码的彻底列表参见这里。

8、错误处理（Error handling）

若是状态码是4xx，就应该向用户返回出错信息。通常来讲，返回的信息中将error做为键名，出错信息做为键值便可。

{ error: "Invalid API key" }

9、返回结果

针对不一样操做，服务器向用户返回的结果应该符合如下规范。

GET /collection：返回资源对象的列表（数组）

GET /collection/resource：返回单个资源对象

POST /collection：返回新生成的资源对象

PUT /collection/resource：返回完整的资源对象

PATCH /collection/resource：返回完整的资源对象

DELETE /collection/resource：返回一个空文档

10、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" }

上面代码表示，服务器给出了提示信息，以及文档的网址。

11、其余

（1）API的身份认证应该使用oauth2.0框架。

（2）服务器返回的数据格式，应该尽可能使用JSON，避免使用XML。

OAuth的思路

OAuth在"客户端"与"服务提供商"之间，设置了一个受权层（authorization layer）。"客户端"不能直接登陆"服务提供商"，只能登陆受权层，以此将用户与客户端区分开来。"客户端"登陆受权层所用的令牌（token），与用户的密码不一样。用户能够在登陆的时候，指定受权层令牌的权限范围和有效期。

"客户端"登陆受权层之后，"服务提供商"根据令牌的权限范围和有效期，向"客户端"开放用户储存的资料。