后端与前端接口命名规范

一、URL地址标准

地址+微服务名称+业务名称，格式为：
http://ip地址/微服务名称/业务名称/接口名
其中业务名称最多为两级，如下所示：
http://120.202.98.109/organization/others/digitalcertificate/接口名

二、接口名命名规范

接口名称必须以动词英文命名，
常用动词为以下：
update 保存
delete 删除
list 返回一个带分页的列表
listall 返回一个全部数据的列表
get 返回一个VO明细

如果遇到不常用的情况，也必须要以动词作为接口名。

三、查询对象（query）

查询对象内为按规范的条件传值，通常为字段类型+运算符，value值就是要查询的内容。

3.1运算符规范

EQ 等于
LIKE 全like
GT 大于
LT 小于
GTE 大于等于
LTE 小于等于
LEFTLIKE 左连接like
RIGHTLIKE 右连接like
IN in查询
NE 不等于

3.2常用查询关键字命名规范

3.2.1多字段模糊查询

多种段模糊查询无论多少个字段，前后端统一用一个单词标识。
查询参数命名：keyword
如：”keyword_LIKE”:”张三”
就是查询列表中多个字段命令里包含了“张三”这两个字的数据。

3.2.2状态查询

状态标识列表中的启用、停用；已审核、未审核等，通常一个列表只有一个状态值查询，如果有多个需要自行命名。
查询参数命名：state
如：”state_EQ”:”1”
就是状态是“启用”的数据，其中0代表停用，1代表启用。

3.2.3时间查询

如果有时间区间或者日期时间查询的，使用次参数。
查询参数命名：time

3.2.3.1”time_EQ”:”时间戳”

就是时间等于时间戳的数据

3.2.3.2时间区间，”time_GTE”:”时间戳”,”time_LTE”:”时间戳”

就是大于等于第一个时间戳，小于等于第二个时间戳的数据。

3.2.4数值查询

查询参数命名：number
常用于数量，或者分数等，不能用于金额，金额有另外的关键字。
如数字区间的查询：”number_GTE”:”100.10”,”number_GTE”:”999”
就是大于等于100.1，小于等于999的数据。

3.2.5金额查询

查询参数命名：money
用于金额的查询。
如金额区间查询：”money_GTE”:”10000”,”money_GTE”:”99999”
就是金额大于等于10000，小于等于99999的数据。