RESTful原则

RESTful 六大原则

1. C-S 架构

数据的存储在Server端,Client端只需使用就行。两端彻底分离的好处使client端代码的可移植性变强,Server端的拓展性变强。两端单独开发,互不干扰。

2. 无状态

http请求本身就是无状态的,基于C-S架构,客户端的每一次请求带有充分的信息能够让服务端识别。请求所需的一些信息都包含在URL的查询参数、header、body,服务端能够根据请求的各种参数,无需保存客户端的状态,将响应正确返回给客户端。无状态的特征大大提高的服务端的健壮性和可拓展性。

当然这总无状态性的约束也是有缺点的,客户端的每一次请求都必须带上相同重复的信息确定自己的身份和状态(这也是必须的),造成传输数据的冗余性,但这种确定对于性能和使用来说,几乎是忽略不计的。

3. 统一的接口

这个才是REST架构的核心,统一的接口对于RESTful服务非常重要。客户端只需要关注实现接口就可以,接口的可读性加强,使用人员方便调用。

4. 一致的数据格式

服务端返回的数据格式要么是XML,要么是Json(获取数据),或者直接返回状态码。

系统分层:客户端通常无法表明自己是直接还是间接与端服务器进行连接,分层时同样要考虑安全策略。

5. 可缓存

在万维网上,客户端可以缓存页面的响应内容。因此响应都应隐式或显式的定义为可缓存的,若不可缓存则要避免客户端在多次请求后用旧数据或脏数据来响应。管理得当的缓存会部分地或完全地除去客户端和服务端之间的交互,进一步改善性能和延展性。

6. 按需编码、可定制代码(可选)

实践

1. 版本

https://example.com/api/v1/
复制代码

2. 参数命名规范

例如:驼峰命名法,下划线命名法

3. url命名规范

https://example.com/api/getallUsers GET 获取所有用户
https://example.com/api/getuser/1 GET 获取标识为1用户信息
https://example.com/api/user/delete/1 GET/POST 删除标识为1用户信息
https://example.com/api/updateUser/1 POST 更新标识为1用户信息
https://example.com/api/User/add POST 添加新的用户
复制代码

4. 统一返回数据格式

例如json格式:

//成功的响应
{
  "code": 200,
  "message": "success",
  "data": {
    "userName": "123456",
    "age": 16,
    "address": "beijing"
  }
}
复制代码
//失败的响应
{
  "code": 401,
  "message": "error  message",
  "data": null
}
复制代码
© 版权声明
THE END
喜欢就支持一下吧
点赞0 分享