Blog Article List API 文档

博客文章-列表

接口信息

  • 接口地址: {your-site-url}/api/skill/blog-article/list
  • 基础 URL: {your-site-url} 需替换为你自己的独立站 URL 地址,如 https://your-domain.com/apimanager666
  • 请求方式: POST
  • Content-Type: application/json
  • 说明: 此接口为查询接口,用于获取博客文章列表

认证

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

Header
skill-access-token {your-skill-access-token} (请替换为你自己的 token)

请求参数 (Query String)

字段 类型 必填 说明
pageNum int 选填 第几页,不填写则默认第 1 页
pageSize int 选填 每页的数据个数,不填写则使用系统默认值
title string 选填 通过文章标题进行模糊搜索
is_published int 选填 发布状态。1 已发布,2 未发布

请求示例

cURL

curl --location --request POST '{your-site-url}/api/skill/blog-article/list?pageNum=1&pageSize=20&title=cover&is_published=1' \
--header 'skill-access-token: {your-skill-access-token}' \
--data-raw ''

返回结果

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

成功响应

{
    "code": 200,
    "data": {
        "list": [
            {
                "id": 474,
                "shop_id": 15,
                "user_id": 0,
                "author": "yu zhang",
                "handle": "fecify-article-3-bfdce56m",
                "title": "封面在顶部",
                "summary_html": "",
                "body_html": "<p>fecify article 3</p>",
                "meta_title": "封面在顶部",
                "meta_keywords": "",
                "meta_description": "fecify article 3",
                "meta_is_edit": 1,
                "translate_type": 3,
                "image": "/blog_article/15/image/2026/02/08/3443b7accccc9b7f1bb993b23e2f7bdd.webp",
                "width": 1024,
                "height": 1024,
                "ratio": "1.00",
                "is_published": 1,
                "published_at": "2026-02-08 22:19:08",
                "created_at": "2026-05-11 17:56:51",
                "updated_at": "2026-05-11 17:56:51",
                "remote_id": "",
                "product_id": 0,
                "product_ids": "",
                "description_json_status": 2,
                "description_json": "",
                "image_show_type": 1,
                "template_type": ""
            }
        ],
        "total": 108,
        "pageSize": 20,
        "totalPage": 6
    },
    "message": "success"
}

返回字段说明

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

data 顶层字段

字段 类型 说明
total int 文章总数
pageSize int 每页的数据个数
totalPage int 总页数
list Array[Object] 文章列表

data.list 子项

字段 类型 说明
id int 文章 ID
shop_id int 店铺 ID
user_id int 创建用户 ID
author string 作者名称
handle string 文章 URL handle
title string 文章标题
summary_html string 文章简短描述(摘要)
body_html string 文章正文(HTML)
meta_title string SEO 标题
meta_keywords string SEO 关键字
meta_description string SEO 描述
meta_is_edit int SEO 是否独立编辑。1 非独立编辑,2 独立编辑
translate_type int 翻译方式
image string 封面图 URL
width int 封面图宽度
height int 封面图高度
ratio string 封面图宽高比
image_show_type int 封面图展示方式。1 显示在顶部,2 显示在底部,3 不显示
is_published int 发布状态。1 已发布,2 未发布
published_at string 发布时间
product_id int 关联的单个商品 ID(已废弃)
product_ids string 关联的商品 ID 数组
description_json_status int 描述是否使用 JSON 字段。1 开启,2 关闭
description_json string JSON 描述内容
template_type string 模板布局样式
remote_id string 远程 ID,一般用于数据同步
created_at string 创建时间
updated_at string 更新时间

注意事项

  1. 所有请求参数均为选填
  2. is_published 可选值:1 已发布,2 未发布
Copyright © fecify.com 2025 all right reserved,powered by Gitbook该文件修订时间: 2026-05-11 19:40:41

results matching ""

    No results matching ""