版本说明

本文档整体适用于 1.9 或以上版本。
具体接口具体字段的适用性在它本身上有具体说明。

数据格式

数据响应是以下的统一格式：

{
    "ret": integer,
    "msg": string,
    "data": {
        "data": array|object
    },
    "time": number,
    "rid": string
}

字段说明如下：

ret 是结果码，0 表示成功，其他均为失败。

msg 描述信息。

data 数据包裹层。

data.data 主要目标数据，如果是列表是数组，否则是对象。注意失败时没有此字段！

time 后端响应耗时，单位：秒。

rid 请求 ID。

当 query string 包含 extra_fields 或 extra_settings 时，会返回相应的数据，与 data.data 同层级。当是列表数据时，分页信息也在这里。

参数名	功能说明
includes	包含关联
include_fields[resourceName]	包含字段
include_counts	包含统计
extra_fields	额外字段，附加在 data.data 同级
extra_settings	额外配置，附加在 data.data 同级
sorts	排序，默认由低到高，在字段前添加 - 则由高到低
filter[fieldName][operator]	and 搜索，operator 省略时默认为 eq
filter_any[fileName][operator]	or 搜索，operator 省略时默认为 eq
per_page	每页数量
page	页码

搜索时可用的 operator 有以下：

eq 等于

gt 大于

gte 大于等于

lt 小于

lte 小于等于

like 模糊匹配

in 范围

有多个值时均使用英文逗号分割。

不同的接口支持的参数不同，每个参数的允许的值也不同，详见各接口文档。

在 include_fields 要包含更多字段时要指定是哪个资源的。以下是所有 resourceName 一览。

资源	resourceName
种子	torrent
用户	user