RESTful规范总结

概念：RESTful（Representational State Transfer 的缩写）是一种广泛使用的API架构风格。

1.资源：在REST API的设计中，首先需要面向资源建模，其中每个节点是是一个简单资源或集合资源。
1.1一个集合包含相同类型的简单资源列表。例如，一个用户拥有一组联系人。
1.2资源具有状态，以及0个或多个子资源，每个子资源可以是一个简单资源或一个集合资源。
2.方法Method：每个资源都有一组操作方法，用户通过API完成对应的操作

RESTful API设计规范

以webService为例通俗解释。

非Rest设计，以往我们都会这么写：

http://localhost:8080/admin/getUser （查询用户）

http://localhost:8080/admin/addUser （新增用户）

http://localhost:8080/admin/updateUser （更新用户）

http://localhost:8080/admin/deleteUser （删除用户）

总结：以不同的URL（主要为使用动词）进行不同的操作。

Rest架构：

GET http://localhost:8080/admin/user （查询用户）

POST http://localhost:8080/admin/user （新增用户）

PUT http://localhost:8080/admin/user （更新用户）

DELETE http://localhost:8080/admin/user （删除用户）

总结：URL只指定资源，以HTTP方法动词进行不同的操作。用HTTP STATUS/CODE定义操作结果。

响应参数
JSON格式（code、data、msg）

状态码
使用适合的状态码很重要，而不应该全部都返回状态码 200

状态码，可根据以下标准按照项目扩展自身状态码：

200~299段 表示操作成功：

200 操作成功，正常返回

201 操作成功，已经正在处理该请求

300~399段 表示参数方面的异常

300 参数类型错误

301 参数格式错误

302 参数超出正常取值范围

303 token过期

304 token无效

400~499段 表示请求地址方面的异常：

400 找不到地址

500~599段 表示内部代码异常：

500 服务器代码异常

部分引用自：https://blog.csdn.net/qq_26420601/article/details/108362730