接口命名规范

注意

由于业务系统通常会分为门户端和管理端两端，所以下面分两种情况进行说明。

不区分portal和admin端的情况

接口命名由三级构成：

• 模块名称：一个业务系统中，可能拥有多个模块，各个模块通过模块名进行区分。如monitor监测模块、engineering工程模块。

• 业务名称：业务名称通常由表名称决定，数据库中的表名往往具有实际的业务含义，在表名由_分段时，可截取最后一段作为业务名称

• 方法名称：最好能够见名知意，知道操作具体代表的含义

也就是：{moduleName}/{businessName}/{interfaceName} 这样的三级结构。

例如：

• /engineering/info/getById
• /engineering/info/save

区分portal和admin

在上面的基础上，在接口前添加portal和admin。

• /portal/engineering/info/getById
• /admin/engineering/info/save

建议的命名规则

• 通常是见名知意的名词
• 首字母小写，多个单词时，采用驼峰命名法
• 不建议使用中文缩写来命名
• 不建议使用下划线作为连接
• 设置的方法一般加对应的动词作为前缀，如save、insert、update、delete
• 查询的方法一般加select、find、query、get作为前缀
• 带有条件的方法一般在命名中使用by或with等字符
• 判断的方法一般以is作为前缀