此处对接口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 | |
开始 | start | Int类型 |
结束 | end | Int类型 |
页码 | pageNo | 默认1 |
每页条数 | pageSize | 默认10 |
主键 | pk | |
令牌 | token |