Restful
一、协议
API与用户的通信协议，总是使用HTTPS协议
二、域名
应该尽量将API部署在专用域名下
https://api.example.com
如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。
https://example.org/api/
三、版本
应该将API的版本号放入URL
https://api.example.com/v1/
四、路径
路径又称为“终点”，表示API的具体网址
在RESTFUL架构中，每个网址代表一种资源，所有网址不能有动词，只能有名词，而且名词往往和数据库的表名对应。
举例来说，有个API提供动物园的信息
https://api.example.com/v1/zoos https://api.example.com/v1/animals https://api.example.com/v1/employees
五、HTTP动词
对于资源的具体操作类型，有HTTP动词表示
常用的HTTP动词有下面五个（括号里是对应的SQL命令）
- GET(SELECT)：从服务器取出资源（一项或多项）
- POST(CREATE)：从服务器新建一个资源
- PUT(UPDATE)：在服务器更新资源（客户端提供改变后的完整资源）
- PATCH(UPDATE)：在服务器更新资源（客户端提供改变的属性）
- DELETE(DELETE)：从服务器删除资源
还有俩个不常用的HTTP动词
- HEAD：获取资源的元数据
- OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的
六、过滤信息
如果记录数量很多，API应该提供参数，过滤返回结果
?limit=10：指定返回记录的数量 ?offset=10：指定返回记录的开始位置。 ?page=2&per_page=100：指定第几页，以及每页的记录数。 ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。 ?animal_type_id=1：指定筛选条件
七、状态码
服务器向用户返回的状态码和提示信息
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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。
八、错误处理
如果状态码是4XX，就该向用户返回出错信息。一般来说，返回信息中讲error作为键名，出错信息作为键值即可
{ error: "Invalid API key" }
九、返回结果
针对不同操作，服务器向用户返回的结果应该符合以下规范
GET /collection：返回资源对象的列表（数组） GET /collection/resource：返回单个资源对象 POST /collection：返回新生成的资源对象 PUT /collection/resource：返回完整的资源对象 PATCH /collection/resource：返回完整的资源对象 DELETE /collection/resource：返回一个空文档
十、Hypermedia API
RESTful API最好做到Hypermedia，即返回结果中提供链接，联向其他API方法，是用户不查文档就知道下一步该做什么
十一、其他
API的身份认证应该使用OAuth框架
服务器返回的数据格式，应该使用JSON
