RESTful API 规范（一）

一，简介

DRF 即Django rest framework

二，rest 规范

1 协议

API 与用户通信，总是使用https协议

2 域名

1) 应尽量将API 部署在域名下（这种情况会存在跨域问题）

https://api.example.com

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

https://example.org/api/

3 版本

应尽量将版本放到URL

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

ps:另一种做法是将版本放在HTTP头信息中，但不如放入URL方便和直观

4 路径

路径又称“终点”，表示API的具体网址。

在RESTful框架中，每个网址代表一种资源，所以网址中不能有动词，只有名称，而且所用的名词往往与数据库的表格名对应，

一般来说，数据库中的表都是同种记录的“集合”，所以API种的名词应该使用复数。

例子：

• 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：获取信息，关于资源的哪些属性是客户端可以改变的。

6 过滤信息（Filtering）

如果记录数量很多，服务器不可能都将他们返回给用户，API应提供参数，过滤返回结果

例子：

• https://api.example.com/v1/zoos?limit=10：指定返回记录的数量

• https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置

• https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数

• https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序

• https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件

7 状态码

服务器向用户返回的状态码和提示信息，常见的有如下：

• 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 错误处理

如果状态码是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方法，如：

{"link": {
  "rel":   "collection https://www.example.com/zoos",
  "href":  "https://api.example.com/zoos",
  "title": "List of zoos",
  "type":  "application/vnd.yourformat+json"
}}

11 其他

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

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