路径前缀 HTTP方法 属性标记 参数类型/格式 API说明
/api/user POST 【O】 JsonObject 添加一个用户
/api/users GET 【A】 读取所有用户
/api/users POST 【B】 JsonArray【E】 批量添加用户
/api/users PUT 【B】 JsonArray【E】 批量更新用户
/api/users DELETE 【B】 JsonArray【ID】 批量删除用户
/api/user/:id PUT 【O】 Path + JsonObject 根据ID更新一个用户
/api/user/:id DELETE 【O】 Path 根据ID删除一个用户
/api/user/:id GET 【O】 Path 根据ID读取一个用户
/api/user/exist POST 【多、B】 JsonObject,特殊查询条件 判断特殊条件用户是否存在
/api/user/and POST 【多、O】 JsonObject,特殊查询条件 AND连接查询,所有条件之间使用AND
/api/users/and GET 【多、A】 Query 【3个条件或以下】AND连接查询,所有条件之间使用OR
/api/users/and POST 【多、A】 JsonObject,特殊查询条件 【3个条件以上】AND连接查询,所有条件之间使用AND
/api/users/and PUT 【多、A】 Query/JsonObject,特殊查询条件 所有条件之间使用AND,按条件批量更新
/api/users/and DELETE 【多、B】 JsonObject,特殊查询条件 所有条件之间使用AND,按条件批量删除
/api/users/or GET 【多、A】 Query 【3个条件或以下】OR连接查询,所有条件之间使用OR
/api/users/or POST 【多、A】 Query/JsonObject,特殊查询条件 【3个条件以上】OR连接查询,所有条件之间使用OR
/api/users/or PUT 【多、A】 JsonObject,特殊查询条件 所有条件之间使用OR,按条件批量更新
/api/users/or DELETE 【多、B】 JsonObject,特殊查询条件 所有条件之间使用OR,按条件批量删除
/api/users/search GET 【多、O\ A】 Query 【快速搜索】根据查询条件搜索满足条件的用户集合,分页参数page, size,支持单字段排序asc=field或desc=field
/api/users/search POST 【多、O\ A】 JsonObject、特殊查询条件(标准条件) 【高级搜索】分页、排序、筛选、过滤的搜索,返回值中带有count。
/api/users/query POST 【多、O\ A】 JsonObject、查询树高级语法(查询树) 【高级查询】提供查询树语法用于高级查询,可分页,可排序
/api/user/{field}/:value GET 【间、单、O】 Path 按某个字段查询用户,实例:/api/user/email/[email protected],按[email protected]读取用户
/api/user/{field}/:value PUT 【间、单、O】 Path + JsonObject 按某个字段更新用户,示例:/api/user/name/xxx,按name=xxx更新用户
/api/user/{field}/:value DELETE 【间、单、B】 Path 按某个字段删除当前用户
/api/users/{field}/:value GET 【间、单、A】 Path 按某个字段读取满足条件的所有用户
/api/users/{field}/:value PUT 【间、单、A】 Path + JsonObject 按某个字段批量更新用户,示例:/api/users/type/single,批量更新type=single的用户
/api/users/{field}/:value DELETE 【间、单、B】 Path 按某个字段删除满足条件的所有用户
/api/users/in/{field} POST 【间、单、O\ A】 JsonArray【T】 拉平返回满足条件的记录,构成JsonArray集,通过参数grouped判断是否执行分组,如果分则则返回值按传入的T执行GroupBy,返回JsonObject键数量和参数【T】的数量一致。
/api/user/exist/{field}/:value GET 【间、单、B】 Path 判断数据库中是否包含该条件的记录,field=value为条件。
/api/user/and/{field}/:value POST 【间、多、A】 JsonObject,特殊查询条件 AND连接查询,主条件使用field=value,符合条件放到JsonObject中
/api/users/or/{field}/:value POST 【间、多、A】 JsonObject、特殊查询条件 OR连接查询,主条件使用field=value, 复合条件放到JsonObject中
/api/users/and/{field}/:value POST 【间、多、A】 JsonObject、特殊查询条件 OR连接查询,主条件使用field=value,复合条件放到JsonObject。
  • 标记为【间】表示根据实际情况进行设计,不直接使用
  • 【E】表示当前集合中只支持JsonObject类型,不可使用其他类型
  • 【ID】则表示当前集合中只允许ID集合,可能是长整型数组,也可能是字符串数组,【T】则表示当前数组中只能是某种类型,这两种标记都表示不可使用JsonObject作为数组元素
  • {field}表示属性占位符,路径中填充上实际属性名
  • 【单】表示单条件,【多】表示多条件
  • 【O】表示返回值为JsonObject,【A】表示返回值为JsonArray,【B】表示返回值为true/false

results matching ""

    No results matching ""