关于Restful Api你所需要知道的

目录：

1.怎么描述Restful style API

    1.1 请求方面

    1.2 响应方面

2.RESTful API会用到的HTTP的方法

3.如何测试一个API

---

API描述的就是对什么做什么，做什么是由http的action定义（get，post等）对于Restful API。我们来了解下怎么描述资源，以及有哪些行为。

1.怎么描述RESTful style API：

1.1 请求方面：

- 域名

若域名无法区分出是api还是页面功能的时候，api路径后面统一加上/api用于区分是接口服务。

https://example.org/api/

- 版本

有两种选择，一种是将API的版本号放入URL。

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

另一种是采用同一个URI。版本号可以在HTTP请求头信息的Accept字段， 这种做法的考虑在于认为不同的版本，可以理解成同一种资源的不同表现形式，所以应该使用同一个URI。

这两种方法没有绝对的对错之分。

- 路径

路径又称"终点"（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

还有一个情况是，从属关系，下一个属于上一个，比如

/teachers/{teacher_id}/timeSlots

某个teacher属于teachers，timslots属于某个teacher

- 过滤信息

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

下面是一些常见的参数。

limit=10：指定返回记录的数量

offset=10：指定返回记录的开始位置。

page=2&per_page=100：指定第几页，以及每页的记录数。

1.2 响应方面：

- 状态码

* 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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

需要注意的是：

如果是路径中的某个值导致找不到结果，则是路径不存在返回404

可是如果是某个parameter的值找不到，则返回200，返回的内容是空

- 返回结果

* GET /collection：返回资源对象的列表（数组）

* GET /collection/resource：返回单个资源对象

* POST /collection：返回新生成的资源对象

* PUT /collection/resource：返回完整的资源对象

* PATCH /collection/resource：返回完整的资源对象

* DELETE /collection/resource：返回一个空文档

- 错误处理（Error handling）

如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。

{

    error: "Invalid API key"

}

---

2.RESTful API会用到的HTTP的方法：

---

3.如何测试一个API

测试一个API最基本的就是测试不同情况下它的返回。可是除此之外还需要从业务，性能方面来测试这个API。

比如业务方面：

这个接口只能根据startdate和daterange来搜索一段时间内的数据。

/api/v1/teachers/{teacher_id}/timeSlots?language={language}&date_begin={dateBegin}&date_range={dateranged}

业务上需要的是根据开始结束时间来搜索，虽然第一个接口也能满足，可是需要转换下，所以接口改成这样更合适。

/api/v1/teachers/{teacher_id}/timeSlots?language={language}&date_begin={dateBegin}&date_end={dateEnd}

比如性能方面：

对于搜索的api，一般需要加一个分页的功能，特别对于返回的数据量比较大的情况。