REST API 接口规范

岁酱吖の 提交于 2019-12-07 06:36:00

设计规范:

协议:使用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方法

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

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

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!