RESTful API

　　RESTful API 是指符合 REST 架构设计的 API 。REST（英文：Representational State Transfer，简称 REST ）翻译是「表示层有状态传输」，具体为 URL 定位资源，用 HTTP 方法（ GET, POST, DELETE, DETC ）描述操作。是 Roy Thomas Fielding 博士于 2000 年在他的博士论文¹ 中提出来的一种万维网软件架构风格，目的是便于不同软件/程序在网络中互相传递信息。

1、使用 HTTPs 协议

2、OAuth 2.0 授权框架或 JWT 协议

3、尽量将 API 部署在专用域名之下

https://api.example.com

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

https://example.com/api/

4、应该将 API 的版本号放入 URL

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

5、路径

　　在 RESTful 架构中，每个网址代表一种资源（ resource ），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的「集合」（ collection ），所以API中的名词也应该使用复数。

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

6、HTTP 方法

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

7、HTTP 参数

待续。。。

8、状态码（ Status Codes ）

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

完整状态码

9、错误信息

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

{
    error: "Invalid API key"
}

10、返回结果

　　返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么，例如当用户向 api.example.com 的根目录发出请求，会得到相应提示。

GET /collection：返回资源对象的列表（ 数组 ）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档

//json
{
    "current_user_url": "https://api.github.com/user",
    ...
}