Skip to content

【旧】分页规范

重定向到 分页.md

分页规范

2017-09-01 larry

准备小范围尝试的版本

METHOD GET
请求
    page_obj    O   string  起始页(不包含),默认第0页
    offset      O   int     查询起点偏移条数,默认0
    limit       O   int     返回条数,默认10。传0表示返回所有数据。
    peek        O   int     希望peek(窥探)的条数,不传就不做peek。
                            peek表示希望接口顺便检查,到底有没有peek条数据,但不需要返回对应的数据。
                            peek必须大于limit。
    reverse     O   bool    是否反向查询。1:是,0:不是
    count       O   bool    是否需要count,1/0,需要测试下,count操作在索引上的耗时是否可接受。
响应
    code    M   int     返回码,0表示成功,其他表示错误
    msg     M   string  错误信息
    data    M   string  返回json数据
    {
        "<data list>": [{  M   list    数据
            key1:         M    string
            key2:         M    string
            ...
        }],
    }
    pagination: { M   dict    分页信息
        peek        O   int     实际peek到的条数。
        more        O   bool    是否有更多数据,1:有更多数据,0:没有更多
        page_obj    M   string  当前页面对象,是一个字符串,作为下次查询的传入串,调用方不需要关心内容
        count       O   int     总数
    }