4.1 通用参数格式
API 接口支持两种参数传递方式:
- Query 参数:通过 URL 查询字符串传递,适用于 GET 请求
- Body 参数:通过请求体传递,适用于 POST 请求
4.2 分页参数说明
大多数列表接口支持分页功能,通用分页参数包括:
| 参数名 | 类型 | 说明 |
|---|---|---|
| page | int | 页码,默认为1, 部分接口使用 current 作为当前页码,请以实际接口为准 |
| limit | int | 每页数量,默认为10, 部分接口使用 paegSize 作为每页数量,请以实际接口为准 |
| offset | int | 偏移量,用于更灵活的分页, 部分接口不支持,请以实际接口为准 |
4.3 排序参数说明
排序参数用于控制返回数据的顺序:
| 参数名 | 类型 | 说明 |
|---|---|---|
| order | string | 排序方式,如 id desc、created_time asc |
4.4 筛选参数说明
筛选参数用于过滤数据:
| 参数名 | 类型 | 说明 |
|---|---|---|
| q | string | 搜索关键词 |
| type | string | 列表类型筛选,type=“list” 不包含分页,type=“page” 包含分页 |
| flag | string | 推荐属性筛选,支持的flag值有:头条[h]推荐[c]幻灯[f]特荐[a]滚动[s]加粗[h]图片[p]跳转[j] |