RESTful API 设计指南

RESTful API 设计指南

 

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

所以，必须有一种统一的机制，方便不一样的前端设备与后端进行通讯。这致使API构架的流行，甚至出现“API First”的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。我之前写过一篇《理解RESTful架构》，探讨如何理解这个概念。

今天，我将介绍RESTful API的设计细节，探讨如何设计一套合理、好用的API。个人主要参考了两篇文章（1，2）。

1、协议

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

2、域名

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

<code class=" language-javascript">
https<span class="token punctuation">:</span><span class="token operator">/</span><span class="token operator">/</span>api<span class="token punctuation">.</span>example<span class="token punctuation">.</span>com
</code>

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

<code class=" language-javascript">
https<span class="token punctuation">:</span><span class="token operator">/</span><span class="token operator">/</span>example<span class="token punctuation">.</span>org<span class="token regex">/api/</span>
</code>

3、版本（Versioning）

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

<code class=" language-javascript">
https<span class="token punctuation">:</span><span class="token operator">/</span><span class="token operator">/</span>api<span class="token punctuation">.</span>example<span class="token punctuation">.</span>com<span class="token regex">/v1/</span>
</code>

另外一种作法是，将版本号放在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做为键名，出错信息做为键值便可。

<code class=" language-javascript">
<span class="token punctuation">{</span>
    error<span class="token punctuation">:</span> <span class="token string">"Invalid API key"</span>
<span class="token punctuation">}</span>
</code>

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的根目录发出请求，会获得这样一个文档。

<code class=" language-javascript">
<span class="token punctuation">{</span><span class="token string">"link"</span><span class="token punctuation">:</span> <span class="token punctuation">{</span>
  <span class="token string">"rel"</span><span class="token punctuation">:</span>   <span class="token string">"collection <a class="token url-link" href="https://www.example.com/zoos">https://www.example.com/zoos</a>"</span><span class="token punctuation">,</span>
  <span class="token string">"href"</span><span class="token punctuation">:</span>  <span class="token string">"<a class="token url-link" href="https://api.example.com/zoos">https://api.example.com/zoos</a>"</span><span class="token punctuation">,</span>
  <span class="token string">"title"</span><span class="token punctuation">:</span> <span class="token string">"List of zoos"</span><span class="token punctuation">,</span>
  <span class="token string">"type"</span><span class="token punctuation">:</span>  <span class="token string">"application/vnd.yourformat+json"</span>
<span class="token punctuation">}</span><span class="token punctuation">}</span>
</code>

上面代码表示，文档中有一个link属性，用户读取这个属性就知道下一步该调用什么API了。rel表示这个API与当前网址的关系（collection关系，并给出该collection的网址），href表示API的路径，title表示API的标题，type表示返回类型。

Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计，访问api.github.com会获得一个全部可用API的网址列表。

<code class=" language-javascript">
<span class="token punctuation">{</span>
  <span class="token string">"current_user_url"</span><span class="token punctuation">:</span> <span class="token string">"<a class="token url-link" href="https://api.github.com/user">https://api.github.com/user</a>"</span><span class="token punctuation">,</span>
  <span class="token string">"authorizations_url"</span><span class="token punctuation">:</span> <span class="token string">"<a class="token url-link" href="https://api.github.com/authorizations">https://api.github.com/authorizations</a>"</span><span class="token punctuation">,</span>
 <span class="token comment" spellcheck="true"> // ...
</span><span class="token punctuation">}</span>
</code>

从上面能够看到，若是想获取当前用户的信息，应该去访问api.github.com/user，而后就获得了下面结果。

<code class=" language-javascript">
<span class="token punctuation">{</span>
  <span class="token string">"message"</span><span class="token punctuation">:</span> <span class="token string">"Requires authentication"</span><span class="token punctuation">,</span>
  <span class="token string">"documentation_url"</span><span class="token punctuation">:</span> <span class="token string">"<a class="token url-link" href="https://developer.github.com/v3">https://developer.github.com/v3</a>"</span>
<span class="token punctuation">}</span>
</code>

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

11、其余

（1）API的身份认证应该使用OAuth 2.0框架。

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

 

相关文章

• 理解OAuth 2.0
• 理解RESTful架构
• nginx 一个例子模块，简单的将http请求的内容返输出
• VC实现HTTP协议的GET和POST方法
• GitLab搭建与维护（基于docker镜像sameersbn/docker-gitlab）
• 配置 OpenLDAP 使用 SSL/TLS 加密数据通讯

转载请注明：爱开源 » RESTful API 设计指南