1. 接口常用的请求方式:
(1)get获取资源
(2)post 新增资源
(3)put更新资源
(4)delete删除资源
2. 接口设计规范:
(1)协议:使用https协议,确保交互数据的传输安全
(2)域名:应该尽量将API部署在专有的域名之下。例如:https://api.example.com
(3)版本控制:将版本号再放Url或者Header中
(4)路径:只能包含名词,不能包含动词
(5)过滤信息:?limit=10 ?offset=10 ?page=10 ?sortby=name
(6)Hypermedia API:在返回结果中提供相关资源的链接,链接其他API方法
(7)验证(Authentication):确定用户是其申明的身份,比如提供用户的密码
(8)授权(Authorization):保证用户有对请求资源特定操作的权限,比如用户的私人信息只能自己能访问,其他人无法看到;有些特殊的操作只能管理员可以操作,其他用户有只读的权限等;
3. 常见的Http status code状态码:
4. 返回结果设计:
5. 接口URL
阮一峰老师的个人博客对Restful API接口讲解更加细致