REST API 接口规范

设计规范:

协议:使用HTTPs协议,确保交互数据的传输安全。

域名:应该尽量将API部署在专用域名之下(https://api.example.com)

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

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

过滤信息

?limit=10 ?offset=10 ?page=1 ?sortby=name

*结果信息限制10条记录:limit/offset

*page显示page号:page

*排序:sortby

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

验证:确定用户是其申明的身份,比如提供账户的密码。

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

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值