restful规范
发布时间 2023-04-03 10:22:43作者: 树苗叶子
什么是restful规范
- REST是Representational State Transfer的缩写,RESTful是一种定义Web API接口的设计风格,尤其适用于前后端分离的应用模式中。
10个规范
- 数据安全的保障,通常使用HTTPS协议
- 接口中带API标识
如:https://api.xxx.com/xxx
如:https://www.xxx.com/api/xxx/xxx
- 多版本共存,路径中带版本信息
如:https://api.xxx.com/v1/
如:https://www.xxx.com/api/v1/xxx
- 数据即资源,均使用名词(如下面的users/books都是名词)
如:https://api.xxx.com/users/
如:https://www.xxx.com/api/books/
注意:一般提倡使用资源的复数形式。在url中不要出现操作资源的动词,如delete-book
特殊的可以出现动词,如login/这种。
- 资源操作由请求方式决定(method)
- 在请求地址中带过滤条件
https://api.baidu.com/books?name=人性的弱点&price=36
- 响应中状态码,一般会有两套,一套是规范的,一套是公司内部规定的
http响应状态码:1xx:请求正在处理,2xx:成功响应,3xx:重定向,4xx:客户端错误,5xx:服务端错误
- 返回数据中带错误信息
- 返回的结果应该符合以下规范(注意:很多公司不遵循此规范)
- GET 获取所有数据:返回资源对象的列表(数组)[{name:红楼梦,price:99},{name:红楼梦,price:99},{name:红楼梦,price:99}]
- GET 单个对象:返回单个资源对象:
- POST 新增对象:返回新生成的资源对象:
- PUT 修改对象:返回完整的资源对象 :
- DELETE 删除:返回一个空文档
- 响应数据中带链接地址