,同一个字段中不应该混合多种类型数据
4、始终返回所有的字段
不要删除字段属性,即使值为空
5、不要滥用JSON对象
API中的每个JSON对象应该始终在请求之间具有不可变性...7、不要依赖普通的硬编码错误信息
接口返回错误时,在响应正文中应该包括严格定义的错误对象,对象一般包括内部代码和附加信息
8、不要使用数字枚举
9、不要返回非封装的响应...13、为你的接口实现限流
API确实实施了速率限制的话,请务必通过响应提供其当前状态来告知你的调用者
14、考虑让你的接口返回支持字段过滤
客户端请求可以指定希望服务端在响应中包括哪些字段或者排除哪些字段...,因为每次当有个新条目在服务端被添加到先前的集合时,先前发送到客户端的偏移offset都变得无效,而且客户端无法得知在两次请求间新增了多少条目。...,不为个别使用方定义接口
定义好统一的路由接口,而非为每一个使用方定义个别处理,如果需要特殊字段,要考虑特殊字段的通用性,如果有通用性,在通用接口上加上字段,其他使用方可维持空,如果没有通用性