接口命名规范

此处对接口url、参数、类型元素等做一定的规范说明:

l  请求方式:Get、Post。

l  数据格式:Json、xml。

l  参数长度约束:主键、Id等唯一字段长度不超过64。

l  参数类型:String,Int,Long,Json,Json数组。

l  约束类型:必选、可选。

l  统一返回码字段:retCode,长度6位。

l  统一返回码描述:retDesc,长度不超过100位。

l  所有接口的url、参数的命名建议使用缩写,并且让人容易理解;命名的第一个单词首字母小写,后面单词首字母大写,下面列出一些公共的名称规范示例:

中文名称命名字段备注
获取get
查询query
新增add
修改mod
删除del
列表list
用户user
班级class
学校school
机构org
应用app
授权Oauth
统计stats
地区area
关系rel例如:用户机构关系:userOrgRel
账号account
平台编码platformCode
开始startInt类型
结束endInt类型
页码pageNo默认1
每页条数pageSize默认10
主键pk
令牌token