Skip to content

Latest commit

 

History

History
18 lines (18 loc) · 1.04 KB

规范声明.md

File metadata and controls

18 lines (18 loc) · 1.04 KB
  1. 请求和返回接口字段全部使用小写下划线
  2. 枚举使用大驼峰
  3. url方法名使用小驼峰
  4. 数据模型名用大驼峰
  5. formData参数使用小驼峰
  6. url必须以**/**开头, +方法名
  7. 不要出现错别字
  8. 所有接口和数据模型都分模块(子目录)
  9. 所有子目录名称使用英文模块名开头。例:User用户相关接口,Login登录相关接口。
  10. 接口请求和返回对象优先使用定义好的数据模型
  11. 字段应为空时返回空字符串或0或null,可能为null的字段必须声明非必选
  12. 接口选择对应的开发负责人
  13. 统一用post
  14. 必须正确标记字段是否必选(字段可不存在/undefined)和是否允许null(字段存在值为null),优先使用非必须,允许null暂时可能导致生成代码异常.
  15. 数组空时不使用null,返回空数组
  16. 接口response调用TaskonResponse类型,覆盖result
  17. 开发中更新文档必须在CHAGNELOG记录,并通知相关人员。
  18. 时间统一毫秒