@(系统架构)[restful]
1. 设置API专属域名，例如 https://api.example.com
2. 将API的版本号记录到URL中，例如： https://api.example.com/v1
3. API网址中不能有动词，只能名词，而且所用的名词和数据库表名相对应，api中的名词如果是个“集合”,则应该使用复数。例如：
https://api.example.com/v1/zoos
https://api.example.com/v1/animals
4. 使用HTTP协议来操作资源：
GET（SELECT）：从服务器取出资源（一项或多项）。
POST（CREATE）：在服务器新建一个资源。
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
DELETE（DELETE）：从服务器删除资源。
HEAD：获取资源的元数据。
OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。
5. 信息过滤。采用一些参数对结果进行过滤，例如：
?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1：指定筛选条件
6. 状态码。
200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
204 NO CONTENT - [DELETE]：用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。。
404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功
7. 错误处理，以error作为key，错误信息作为value返回。{error: “Invalid API key”}
8. 返回结果。
GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档
9. 返回结果中有相关的链接，提示用户可进行的下步操作。