模版装修-模板文件树-获取

获取指定店铺模板的全部文件树结构。系统模板支持二次开发,通过此接口可以查看模板中的所有文件,用于模板定制和开发。

接口信息

  • 接口地址: {your-site-url}/api/skill/theme-liquid/get-file-tree
  • 基础 URL: {your-site-url} 需替换为你自己的独立站 URL 地址,如 https://your-domain.com/apimanager666
  • 请求方式: GET
  • 说明: 获取指定店铺模板的完整文件树。该文件结构和 Shopify 模板结构一致,系统模板支持二次开发,可在原始文件基础上修改以定制模板。

    返回两个树:

    • final_tree:最终文件树(包含原始文件和二次开发修改后的文件)
    • develop_tree:仅包含进行了二次开发的文件

认证

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

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

请求参数 (Query String)

字段 类型 必填 说明
theme_id int 店铺模板 ID。从 店铺模版-列表 获取

请求示例

cURL

curl --location --request GET '{your-site-url}/api/skill/theme-liquid/get-file-tree?theme_id=832' \
--header 'skill-access-token: {your-skill-access-token}'

返回结果

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

成功响应

{
    "code": 200,
    "data": {
        "tree": {
            "final_tree": {
                "assets": [
                    "base.css",
                    "base.js",
                    "header.css",
                    "header.js"
                ],
                "config": [
                    "settings_data.json",
                    "settings_schema.json"
                ],
                "layout": [
                    "theme.liquid",
                    "checkout.liquid"
                ],
                "locales": [
                    "site_lang_en.json",
                    "site_lang_cn.json"
                ],
                "sections": [
                    "header.liquid",
                    "footer.liquid",
                    "main-product.liquid"
                ],
                "snippets": [
                    "product-card-1.liquid",
                    "breadcrumb.liquid"
                ],
                "templates": [
                    "home.json",
                    "product.json",
                    "collection.json"
                ]
            },
             "develop_tree": {
                "sections": [
                    "2222.liquid",
                    "affiliate-apply.liquid"
                ]
            }
        }
    },
    "message": "success"
}

返回字段说明

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

data → tree → final_tree

final_tree 是最终文件树(包含原始文件和二次开发修改后的文件),包含以下文件夹:

文件夹 类型 说明
assets Array[string] JS 和 CSS 文件,前端静态资源
config Array[string] 全局配置。settings_schema.json 为配置结构定义(schema),settings_data.json 为当前配置值(data)
layout Array[string] 总入口布局文件。theme.liquid 为常规页面入口,checkout.liquid 为订单结账页面入口
locales Array[string] 多语言翻译文件。格式为 site_lang_{lang_code}.json
sections Array[string] 装修卡片对应的 section 文件。每个 .liquid 文件代表一个可拖拽的页面区块
snippets Array[string] 小部件/代码片段。在 sections 中通过 include 引入,为可复用的公共组件
templates Array[string] 页面装修的 JSON 配置文件。每个 .json 定义该页面使用的 section 组合。例如 home.json 为首页,product.json 为产品页

data → tree → develop_tree

develop_tree 结构同 final_tree,包含相同的文件夹分类(assetsconfiglayoutlocalessectionssnippetstemplates),但仅列出进行了二次开发(通过 模版装修-模板文件内容-保存 修改过)的文件。未进行二次开发时各文件夹为空。


文件类型说明

类型 后缀 说明
Liquid 模板 .liquid 模板引擎文件,支持变量、条件判断、循环等
JSON 配置 .json 页面/区块的配置数据文件
CSS .css 样式文件
JavaScript .js 脚本文件
图片 .png.webp 静态图片资源

注意事项

  1. theme_id店铺模版-列表 获取
  2. 只有新架构模板(Liquid 模板)支持通过文件树进行二次开发
  3. 获取文件树后,可通过文件读取/写入接口对模板进行定制修改
  4. 各目录下的文件按字母顺序排列
Copyright © fecify.com 2025 all right reserved,powered by Gitbook该文件修订时间: 2026-06-05 21:47:22

results matching ""

    No results matching ""