REST API设计

1、REST设计原则

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

域名
应该尽量将API部署在专用域名之下。
https://api.xxx.com
如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。
https://crm-xxx.com/api/

版本（Versioning）
应该将API的版本号放入URL。
https://api.xxx.com/v1/
另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。Github采用这种做法。

 

路径（Endpoint）
路径又称"终点"（endpoint），表示API的具体网址。
在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。
举例来说，有一个API提供动物园（zoo）的信息
https://api.xxx.com/v1/zoos

2、HTTP动词

对于资源的具体操作类型，由HTTP动词表示。
常用的HTTP动词有下面五个（括号里是对应的SQL命令）。

• GET（SELECT）：从服务器取出资源（一项或多项）。
• POST（CREATE）：在服务器新建一个资源。
• PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
• PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
• DELETE（DELETE）：从服务器删除资源。

GET和POST的区别：

GET：字面理解就是获取资源

• GET请求标准上是幂等的（用户应该认为请求是安全的-资源不会被修改，这里所以说应该是服务器端并不保证资源不会被修改）

• GET请求可以被浏览器缓存；响应也可以被缓存（根据缓存头信息来处理）

• GET请求可以保存在浏览器历史记录中，也可以作为链接分发或分享，可以收藏为书签

• GET请求的数据都在URL中，可以方便都从浏览器中获取数据（因此不能携带诸如密码的明文数据）

• GET请求的长度会有限制（比如IE的路径总长度需小于2048个字符）

• GET请求的数据只能包含ASCII字符

POST：字面理解就是发布新资源

• POST请求标准上不是幂等的（用户应该认为请求是有副作用的-可能会导致资源修改）

• POST请求URL可以被浏览器缓存，但是POST数据不会被缓存；响应可以被缓存（根据缓存头信息来处理）

• POST请求不便于分发或分享，因为POST数据会丢失，不能收藏为书签。

• POST请求没有长度限制，可以用来处理“请求数据”很大的场景（只要不超过服务器端的处理能力）

• POST请求的数据不限于ASCII字符，可以包含二进制数据

幂等：粗略的讲是对同一URL的多个请求应该返回同样的结果。

下面是一些例子。

• 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：删除某个指定动物园的指定动物

 

如果查询的是一个集合，还需要加过滤条件(如果有排序，还需要定义排序的白名单)，防止数据库压力过高，如下：

• ?limit=10: Reduce the number of results returned to the Consumer (for Pagination)
• ?offset=10: Send sets of information to the Consumer (for Pagination)
• ?animal_type_id=1: Filter records which match the following condition (WHERE animal_type_id = 1)
• ?sortby=name&order=asc: Sort the results based on the specified attribute (ORDER BY name ASC)

3、返回结果

格式：统一返回json

状态码（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]：用户请求的资源被永久删除，且不会再得到的。
• 500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

转载于:https://my.oschina.net/jumpLee/blog/1529137