图片-列表

图片-获取图片列表

接口信息

  • 接口地址: {your-site-url}/api/skill/image/list
  • 基础 URL: {your-site-url} 需替换为你自己的独立站 URL 地址，如 https://your-domain.com/admin
  • 请求方式: GET
  • Content-Type: application/json
  • 说明: 获取服务端后台图片选择器中的图片列表，支持分页和按创建时间区间筛选。

认证

请求头中需要携带 skill-access-token：

Header 值
skill-access-token {your-skill-access-token} （请替换为你自己的 token）

请求参数

字段 类型 必填 说明
pageNum Number 否 页码，默认第 1 页
pageSize Number 否 每页数量，默认 20
begin_at String 否 创建时间区间-开始时间，支持 YYYY-MM-DD（如 2024-07-02）或 YYYY-MM-DD HH:mm:ss（如 2024-07-02 00:00:00）
end_at String 否 创建时间区间-结束时间，支持 YYYY-MM-DD（如 2026-08-21）或 YYYY-MM-DD HH:mm:ss（如 2026-08-21 23:59:59）

请求示例

cURL

curl --location --request GET '{your-site-url}/api/skill/image/list?pageNum=1&pageSize=10&begin_at=2024-07-02&end_at=2026-08-21' \
--header 'skill-access-token: {your-skill-access-token}' \
--header 'Content-Type: application/json'

返回结果

code 为 200 表示调用成功；code 不为 200 表示调用失败。

成功响应

{
    "code": 200,
    "data": {
        "upload_img_max_size": 40960,
        "upload_img_allow_types": [
            "image/gif",
            "image/jpeg",
            "image/png",
            "image/webp",
            "image/avif"
        ],
        "list": [
            {
                "id": 46706,
                "name": "8f0eb2d3d780cdc957c72de7fda11262.jpg",
                "path": "/common/0/image/2025/12/14/8f0eb2d3d780cdc957c72de7fda11262.jpg",
                "shop_id": 0,
                "width": 750,
                "height": 1024,
                "ratio": "0.73"
            }
        ],
        "total": 8,
        "pageSize": 10,
        "totalPage": 1
    },
    "message": "success"
}

返回字段说明

字段 类型 说明
code Number 状态码，200 表示成功
message String 执行结果的文字描述
data Object 返回数据

data 子字段

字段 类型 说明
upload_img_max_size Number 图片上传最大值，单位 KB
upload_img_allow_types Array 支持的图片 MIME 类型列表
list Array 图片列表
total Number 图片总数量
pageSize Number 每页数量
totalPage Number 总页数

data.list 子字段

字段 类型 说明
id Number 图片 ID
name String 图片文件名
path String 图片路径（相对路径）。通过 获取基本信息 接口获取的 base_image_url + path 可拼接得到完整图片 URL
shop_id Number 所属店铺 ID，0 表示总后台图片
width Number 图片宽度（单位：px），0 表示未获取到宽高信息
height Number 图片高度（单位：px），0 表示未获取到宽高信息
ratio String 图片宽高比

注意事项

  1. list.path 为相对路径，需通过 获取基本信息 接口获取 base_image_url，拼接后得到完整图片 URL（base_image_url + path）。
  2. width 和 height 为 0 表示该图片上传时未记录尺寸信息。
  3. upload_img_max_size 的单位为 KB，上传图片时需注意文件大小限制。
  4. begin_at 和 end_at 用于按创建时间区间筛选图片，均为可选参数，不传则不限制时间范围。

results matching ""

    No results matching ""