XwFast
  1. 通用示例接口
XwFast
  • 通用示例接口
    • README
    • 保存数据
      • 新增/更新数据
      • 新增/更新数据(批量)
    • 查询数据
      • 查询全部
      • 通过ID查询
      • 通过ID查询(批量)
      • 通过实体查询数据集合
      • 指定字段和值查询数据
      • 指定字段和值查询数据(批量)
      • 自定义高级查询
    • 删除数据
      • 通过ID删除数据
      • 通过ID删除数据(批量)
      • 指定字段及值删除数据
      • 指定字段及值删除数据(批量)
    • 计数接口
      • 通过实体查询数量
      • 指定字段和值查询数量
  1. 通用示例接口

README

普通接口(保存、删除、查询、计数)格式请参考 通用示例接口

接口名称#

接口名称遵循规则: 实体编码 + / + 操作
具体有哪些操作可以查阅通用示例接口中的各个接口。

响应格式#

{
    "code": "",
    "message": "",
    "data": {}
}
1.
code:响应状态,可能包含以下情况:
SUCCESS:请求处理成功
FAIL:请求处理失败
NOT_FOUND:资源不存在
PARAM_EMPTY:请求参数为空
SERVER_BUSY:服务繁忙
NO_AUTHORITY:无权限访问
自定义其他状态
2.
message:消息提示
3.
data:响应数据,可能为对象/数组/基础类型,根据请求接口情况而定

通用实体结构#

每个 Java 实体都具备的公共字段(数据库表为单词大写下划线分隔):
字段名含义类型注意
id主键 ID整数类型雪花算法
deleted删除状态数字类型前端无须关注,后端自动维护
createBy创建人字符串无
updateBy修改人字符串无
createTime创建时间日期时间无须传入,后端自动维护
updateTime更新时间日期时间无须传入,后端自动维护
下一页
新增/更新数据
Built with