README
普通接口(保存、删除、查询、计数)格式请参考
通用示例接口
接口名称
接口名称遵循规则: 实体编码
+ /
+ 操作
具体有哪些操作可以查阅通用示例接口中的各个接口。
响应格式
{
"code": "",
"message": "",
"data": {}
}
code
:响应状态,可能包含以下情况:SUCCESS
:请求处理成功FAIL
:请求处理失败NOT_FOUND
:资源不存在PARAM_EMPTY
:请求参数为空SERVER_BUSY
:服务繁忙NO_AUTHORITY
:无权限访问- 自定义其他状态
message
:消息提示data
:响应数据,可能为对象/数组/基础类型,根据请求接口情况而定
通用实体结构
每个 Java 实体都具备的公共字段(数据库表为单词大写下划线分隔):
字段名 | 含义 | 类型 | 注意 |
---|---|---|---|
id | 主键 ID | 整数类型 | 雪花算法 |
deleted | 删除状态 | 数字类型 | 前端无须关注,后端自动维护 |
createBy | 创建人 | 字符串 | 无 |
updateBy | 修改人 | 字符串 | 无 |
createTime | 创建时间 | 日期时间 | 无须传入,后端自动维护 |
updateTime | 更新时间 | 日期时间 | 无须传入,后端自动维护 |
最后修改时间: 1 年前