通用参数释义

id 参数

常见于获取单条资源、修改、删除

# 接口地址中出现 {id}
/api/xxx/{id}
# 调用示例
/api/xxx/{1}
# 部分批量操作接口可传入多个 id，用英文逗号 ',' 分隔
/api/xxx/{1,2,3}

关联参数

常见于获取数据时，根据需要在 GET 参数中传入 include

# 关联字段，多个字段用英文逗号分隔，传入参数必须存在于 $include 或 $optionalInclude 中
/api/xxx?include=user,posts

// 可在自己的控制器中重写下面两属性修改默认值
// 定义默认被包含的关系
public $include = [];
// 其它可用的关系
public $optionalInclude = [];
// 控制器获取方式
$include = $this->extractInclude($request);

页码参数

常见于获取列表数据，根据需要在 GET 参数中传入 page

// 可在自己的控制器中重写下面两属性修改默认值
// 基类默认最大获取数量
public $maxLimit = 50;
// 基类默认获取数量
public $limit = 20;
// 控制器获取方式
$limit = $this->extractLimit($request);
$offset = $this->extractOffset($request);

排序参数

常见于获取列表数据，根据需要在 GET 参数中传入 sort

# 排序字段，多个字段用英文逗号分隔，倒序的字段前使用减号
/api/xxx?sort=id,-count,time

// 可在自己的控制器中重写下面两属性修改默认值
// 定义可被用于排序的字段
public $sortFields = [];
// 定义默认排序字段
public $sort = [
    'updatedAt' => 'desc'
];
// 控制器获取方式
$sort = $this->extractSort($request);

返回页码链接

常见于获取列表时返回的数据

数据通用字段

所有数据模型都以这种格式返回