rest api接口规范

2020-4-5 wenruding API学习

1.协议:使用HTTPS协议,确保交互数据的安全性

2.域名:应该尽量将api部署在专用域名下面,比如https://api.wenruding.club

3.版本控制:将版本号放在URL或者Header中

4.路径:只能包含名词,不能包括动词

5.过滤信息:

?limit=10(j结果限制10个)  ?offset=10(返回10条记录)  ?page=1(返回显示pages号)  ?sortby=name(结果排序)

6.Hypermedia API:在返回结果中提供相关资源的链接,连向其他API方法

7.验证(Authentication):确定用户是其申明的身份,比如提供账户的密码

8.授权(Authorization):保证用户有对请求特定的资源的操作权限.比如用户的私人信息只能自己访问,其他人无法看到;有些特殊的操作稚嫩管理员可以操作,其他用户有只读权限等


标签: API

Powered by 爱技术笔记 粤ICP备18154459号