Restful 接口规范

简介

2000年Roy Fielding博士在其博士论文中提出REST(Representational State Transfer)风格的软件架构模式后,REST就基本上迅速取代了复杂而笨重的SOAP,称为Web API标准了。

RestFul作为当前最流行的API设计规范,有着它独特的魅力:强大、简洁、易上手。

RestFul具体规范规则

1.建议使用https代替http请求,保证数据传输的安全性
2.域名:在URL中有api标识,让我们看到api就知道此url是完成前后台数据交互的
	https://www.cnblogs.com/api/xwgblog/p/11812244.html #推荐使用	
	https://api.cnblogs.com/xwgblog/p/11812244.html #存在跨域问题
3.版本:在URL中要对不同的版本进行标注,以便于记录版本的更新迭代
	https://www.cnblogs.com/api/v1/userinfo/ 
	https://www.cnblogs.com/api/v2/userinfo/
4.资源:请求的目标数据称之为资源,资源一般使用名词不用动词
	https://www.cnblogs.com/api/v1/userinfo/
5.资源过滤:通过接口传递参数来过滤资源
	https://www.cnblogs.com/api/v1/userinfo/?page=1&category=2
6.根据method不同做不同的操作(数据的增删改查)
	get/post/put/patch/delete
7.状态码:返回数据要标注状态码
8.错误信息:请求失败需要标注错误信息
	{"message":"请求参数不合法"}
9.操作结果:请求操作成功返回的结果{"results":[]}
	--get:返回资源列表或返回单一资源
  --post:返回单一新增资源
	--put:返回更新的资源
	--patch:返回更新的资源
	--delete:返回空文档
10.子资源返回资源接口:返回的资源如果有子资源,返回子资源的链接地址,如查找书,书的封面图片就可以url表示
posted @ 2020-06-23 21:26  末兰岩  阅读(111)  评论(0编辑  收藏  举报