restful接口返回结果result结构设计.pdfVIP

restful接⼝返回结果result结构设计 每⼀个公司 RESTFUL接⼝返回结果结构风格都不⼀样，在想为什么会这样，没有⼀些统⼀完整的标准规范。 例如：⽐较常见的result:{status,msg,data},然⽽使⽤status值类型竟不相同，有⼈⽤ int,有⼈⽤ string，个⼈选择⽤ int，占有4个字 节，原因简单明了的状态码,使⽤数字描述更简单，其实status这字段也有⼈使⽤ status code结果值反馈也不相同，有⽤1表⽰成功，⾮1表⽰失败，有⽤200表⽰成功，⾮200表⽰失败,个⼈选择 200 表⽰成功，⾮200表⽰⾮成 功，原因这个符合浏览器的 status值。 另外 result中的三个字段能不能诠释出这个接⼝的所有信息，data表⽰返回结果值，如果当⾮正常情况下，接⼝需要其它的业务信息 ，就 没有字段保存，这时会增加⼀个bizInfo。 当接⼝异常的时候， msg直接提⽰出程序异常信息，客户看见这样的信息⼀是很奇怪，⼆是很反感，那应该提⽰ “系统异常，联系管理 员”，给出客户明确的指⽰，那对于开发⼈员来说，就不能直观快速的定位问题，给于客户的响应,这时 我个⼈会增加⼀个 exception的字段。 还有⼀个场景就是分页的