接口规范(实际项目中体会到的,会造成很多问题的)

1.索引规则 : 业务上具有唯一特性的字段,即使是组合字段,也必须建成唯一索引。

个人理解:(原则每一层数据,只有一个索引id)
实际应用中:原则做过类似项目,出现很多索引id,图斑id,自然幢id,标识码,任务id,户id等。导致接口很乱,因为每一个id对应的key不一样,容易出错。每一级的数据应只有一个索引。
此项目只用到两层(建筑和户),只需要两个索引就行。

2. 统一规范返回数据的格式,对己对彼都有好处,此处以json格式为例。返回数据应包含:返回状态码、返回状态信息、具体数据。

{
        Status: 状态码
        Message:“成功或者失败理由”
        Data{
}
}

前台弹出返回json串的message信息,可以让前台用户,清楚知道出问题原因。例如(用户名不对,密码不对,填写数据有瑕疵等提示)

3. 接口返回数据原则

            *.  前台需要哪些字段,api接口应返回哪些字段,不应该少,也不应该多
(不只是会显得乱的问题,如果是list展示,返回数据过多,接口速度,传输会变慢)
            *.  返回数据结构要和数据一致性(数组数据就是数据,对象就是对象,而不是返回数量为1的数组)
            *.  返回数据量,数量不确定(有可能很大的),应提前做好分页。

            *.  布尔值类型:统一使用字符串’0’和’1’来表示假和真,性别 0代表未知或者保密,1男2女。

            *.  不返回Null类型数据

4.命名规则

     *接口名,参数名,返回数据名称,不出现拼音,或者拼音首字母缩写的。

     *不同页面相同的数据,应使用统一参数名字。 例如(城市住宅,城市非住宅,等不同表里边,省市县,姓名,等应使用统一参数名称)

5.好的习惯(一些好的习惯,就会避免一些问题的产生)

      *应遵守单页面,单接口规则,避免一个界面请求多个接口。
      (例如提交的时候,如果分成多次提交,有可能出现,有的接口提交成功,有的失败的情况,出现垃圾数据)
     *路径应给全,而不是前台去拼接。(例如返回图片的路径,前台拼接,后台如果改变路径,前台需要对应改路径,发新版本,图片会不能显示)
      *

6. 请求方式

    *post:新增数据
     * get:获取数据
Get参数有长度限制,参数过多用post,登录更新密码等与用户信息有关的优先用post。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 前言 本开发规范基于《阿里巴巴Java开发手册终极版》修改,并集成我们自己的项目开发规范,整合而成。 为表示对阿里...
    4ea0af17fd67阅读 5,681评论 0 5
  • 无规矩不成方圆,编码规范就如同协议,有了Http、TCP等各种协议,计算机之间才能有效地通信,同样的,有了一致的编...
    sherlockyb阅读 5,078评论 1 5
  • 关于Mongodb的全面总结 MongoDB的内部构造《MongoDB The Definitive Guide》...
    中v中阅读 32,073评论 2 89
  • 因为工作需要,公司组里要求考阿里巴巴编程规范,于是我花了一天的时间看了一遍,然后刷了一些题,终于在第三次的时候考过...
    添砖java的啾阅读 6,032评论 0 2
  • 16宿命:用概率思维提高你的胜算 以前的我是风险厌恶者,不喜欢去冒险,但是人生放弃了冒险,也就放弃了无数的可能。 ...
    yichen大刀阅读 6,122评论 0 4