RESTful设计指南：构建高效统一前后端通信机制.pdfVIP

RESTfulAPI设计指南

Referenc

来源于：/blog/2014/05/restful_api.html

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

面电脑、其他专用设备）。

因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。这导致API构架的流行，甚至出

现APIFirst的设计思想。RESTfulAPI是目前比较成熟的一套互联网应用程序的API设计理论。我以前写

过一篇《理解RESTful架构》，探讨如何理解这个概念。

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

（1，2）。

一、协议

API与用户的通信协议，总是使用HTTPs协议。

二、域名

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

如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。

/api/

三、版本（Versioning）

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

/v1/

另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。Github采用这种做法。

四、路径（Endpoint）

路径又称终点（endpoint），表示API的具体网址。

在RESTfu