什么是 REST
REST 是 REpresentational State Transfer 的缩写，维基百科上解释是表述性状态传递，是Roy Fielding博士在2000年他的博士论文中提出来的一种软件架构风格。REST 是一种基于 Web 标准的软件架构，一种设计风格而不是标准，与技术无关，按照这种设计风格设计出来的API就叫做Restful Api。
什么是Restful
Rest和Restful是不能完全相等的，Restful是遵守了Rest原则的web服务。
REST特性
1. 资源
REST 架构把所有内容都视为资源。这里每个资源都都对应着唯一的全局资源定位符URI标识。这些资源可以是文本文件，html 页面，图像，视频或者动态业务数据。资源是整个REST的基础。
所有的管理操作都是通过HTTP协议的action来实现（GET/POST/DELETE/PUT）实现增删改查。
REST服务器只提供对资源的访问，REST 客户端访问和修改资源。REST 使用不同的表示形式表示资源，比如文本，JSON，XML。XML 和 JSON 是最流行的资源表示形式。
所有的操作都应该是无状态的，就是不应该使用Session。
良好的资源表示形式
下面是在 RESTful Web 服务中设计资源表示格式时要考虑的重点。
1）可理解性：服务器端和客户端都应该能理解和利用资源表示格式。
2）完整性：格式应该能够完整地表示一个资源。比如，资源可以包含另一个资源。格式应该能够表示简单以及复杂的资源结构。
3）可连接性：资源可以链接到另一个资源，格式应该能够处理这种情况。
RESTful的优点：
- 基于http协议，调用简单，轻量。
- 可以实现前后端分离，事先可以约定好接口，参数和调用方法，前端和后端人员更加专注于各自开，互不干扰，节省开发时间。
- 安全问题集中在接口上，由于接受json格式，防止了注入型等安全问题。
- 前端无关化，后端只负责数据处理，前端表现方式可以是任何前端语言（android，ios, html5）。
- 服务器性能优化：由于前端是静态页面，通过nginx便可获取，服务器主要压力放在了接口上。
Restful Api设计原则
1. 协议
API与用户的通信协议，总是使用HTTPs协议。
2. 域名
应该尽量将API部署在专用域名之下。例如 https://api.example.com。
如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下，例如 https://example.org/api/。
3. 版本（Versioning）
应该将API的版本号放入URL。例如 https://api.example.com/v1/。
下面截图就是放在URL上的。
另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。
4. URL命名（或者叫路径（Endpoint））
URL命名表示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
所以URL命名一般可以按照下面规则
/资源名称
/资源名称/{资源ID}
/资源名称/{资源ID}/子资源名称
/资源名称/{资源ID}/子资源名称/{子资源ID}
5. HTTP动词
对于资源的具体操作类型，由HTTP动词表示。常用的HTTP动词如下（括号里是对应的SQL命令）。
GET（SELECT）：从服务器取出资源（一项或多项）。
POST（CREATE）：在服务器新建一个资源。
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
DELETE（DELETE）：从服务器删除资源。
HEAD：获取资源的元数据。这个
OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。
HEAD和OPTIONS这两个不常用。
下面是Restful Api范例，管理商品资源所对应的api
| URI | action | 说明 |
| http://www.host.com/goodlists | GET | 获取商品列表数据 |
| http://www.host.com/goodlists | POST | 创建一个新的商品 |
| http://www.host.com/goodlists/101 | GET | 获取编号为101商品的详情 |
| http://www.host.com/goodlists/101 | PUT | 修改编号为101商品 |
| http://www.host.com/goodlists/101 | DELETE | 删除编号为101商品 |
| http://www.host.com/goodlists/101/price | GET | 获取编号为101商品的价格 |
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作为键名，出错信息作为键值即可。
9. 安全性和幂等性
安全性和幂等性有时候容易被忽视，但是也很要。
安全性：指调用接口不对资源产生修改。
幂等性：指调用方法1次或N次对资源产生的影响结果都是相同的。
10. 鉴权
REST 设计原则并未提到有些需要权限的业务场景下应该怎么做。在实践中，推荐使用 OAuth 2.0 标准来实现 API 的鉴权需要。
参考资料