文档目录

过滤、排序和分页

过滤

  • 精准过滤,以字段名为参数,如以下条件用于查询name字段为“小H”的客户:/customers?name=小H
  • 过滤规则使用LHS Brackets格式:
    • 在列表中(in): /customers?id[in]=1,2,3,4,5
    • 大于(gt): /customers?id[gt]=55
    • 大于等于(ge): /customers?id[ge]=55
    • 小于(lt): /customers?id[lt]=55
    • 小于等于(le): /customers?id[le]=55

排序

  • 按某字段正序排列
    • /customers?sort=id
  • 按某字段逆序排列
    • /customers?sort=-id

分页

  • 使用排序字段和高级过滤,以及limit来进行分页
    • 如,按id升序,每页100条记录,id大于1000的客户为: /customers?sort=id&id[gt]=1000&limit=100
  • 为避免单次获取过多记录,给服务器造成不必要的压力,limit最高限制为2000,即最多返回2000条记录。

字段选择

  • 字段选择使用select参数,如select=id,name,gender

代码示例