7、不要依赖普通的硬编码错误信息
接口返回错误时,在响应正文中应该包括严格定义的错误对象,对象一般包括内部代码和附加信息
8、不要使用数字枚举
9、不要返回非封装的响应...,资源的URI和其他信息都是动态发现的,当服务端发送变化时,客户端并不需要做出修改
12、考虑让你的接口结果可缓存
客户端可以缓存服务器返回的响应结果,服务器可以定义响应结果的缓存时长设置...,这样可以有效处理响应膨胀
15、接口支持高级分页
分页可以减少客户端接收的数据数目,但是当你需要将分页结果与不断接收的新条目结合时,通常的限制limit和偏移offset分页参数是低效的...保持客户端同步一个比较好的办法是使用before_id和after_id参数组合,比如客户端将已知的最新条目的id作为after_id请求参数,然后检索之后创建的新条目
16、接口异常显式返回...findBy方法和各自的重载,正确的打开方式应该类似组合模式
public interface StudentApi{
Student findBySpec(StudentSpec spec)