无歧义的服务名
记住你的URL应该能充分表达出真实作用,而不是需要翻阅文档才能了解,另外不要不情愿使用版本号命名路由,当然服务版本应该要做到向下兼容
3、数据类型强一致
数值字段应该始终只包括数字...,字符类型字体意义始终只包括字符串,同一个字段中不应该混合多种类型数据
4、始终返回所有的字段
不要删除字段属性,即使值为空
5、不要滥用JSON对象
API中的每个JSON...对象应该始终在请求之间具有不可变性,具有严格的定义的字段集,下面这种返回就是可怕的做法
?...,比如我们可以使用is_available布尔值标识book的状态,但是它没有表明为啥是不可用状态?...,要考虑特殊字段的通用性,如果有通用性,在通用接口上加上字段,其他使用方可维持空,如果没有通用性,作为一个配置字段配置进去
文章翻译摘录自:
[Part 1: Introduction and planning