Restful API

一、协议
API与用户的通信协议，毫无疑问的HTTPs协议
二、域名
应该尽量将API部署在专有域名下，例"api.tangxuelin.com"
三、版本
应该尽量把API的版本号放入URL中，例"api.tangxuelin.com/v1/"
四、路径
又称"终点"，表示API的具体网址
在Restful架构中，每个网址代表着一种资源，所以网址中不能有动词，只有名词，并且使用复数式
五、HTTP动词
对于资源的具体操作类型由HTTP动词表示
常用的GET、POST、PUT、PATCH、DELETE，不常用的HEAD、OPTIONS
六、过滤信息
当记录数据量过大时，服务器不应该全部提供给用户，而是通过API提供的参数过滤之后返回给用户结果
参数的设计允许存在冗余，即API的路径和URL参数偶尔重复
七、状态码
服务器向用户返回的请求处理状态码以及提示信息
八、错误处理
如果状态码为4xx，就应该向用户返回错误信息
九、返回结果
针对不同的操作，服务器向用户返回的结果应该符合规范
十、Hypermedia API
Restful API应该尽量坐到Hypermedia API，即在返回结果中提供链接，以供用户跳转向其他API方法，增强用户体验
十一、补充
1、API的身法认证框架应该使用OAuth2.0
2、服务器返回的数据格式，尽量使用JSON，避免使用XML