开发Shopify FAQ应用：如何利用Shopify数据库实现CRUD及查询端点

核心方案：利用Shopify Metafield存储FAQ数据 #

Shopify没有专门的FAQ数据库表，最适合的方式是用Metafields存储自定义FAQ数据。Metafield可依附于Shop（店铺级FAQ）、Product（产品级FAQ）等资源，完全满足无需自建数据库的需求。推荐先创建自定义Metafield Definition来规范FAQ的数据结构，方便后续管理。

一、提前准备：创建Metafield Definition（可选但推荐） #

通过Metafield Definitions API创建针对Shop资源的FAQ集合定义，统一数据格式：

• Namespace：自定义，比如faq_app（用于区分你的应用数据）
• Key：比如store_faqs
• Type：list.object（存储多个FAQ条目，每个条目包含question和answer字段）
• Owner resource：shop（表示该metafield属于整个店铺）

创建Definition的API端点（POST） #

/admin/api/2024-07/metafield_definitions.json

请求体示例：

{
  "metafield_definition": {
    "name": "Store FAQs",
    "description": "Store-wide FAQ entries for the FAQ app",
    "namespace": "faq_app",
    "key": "store_faqs",
    "type": "list.object",
    "owner_resource": "shop",
    "validations": [
      {
        "name": "object",
        "value": "{\"properties\":{\"question\":{\"type\":\"string\"},\"answer\":{\"type\":\"string\"}}}"
      }
    ]
  }
}

二、CRUD操作具体实现 #

1. 创建FAQ（Create） #

若已创建Metafield Definition，直接往对应的Shop Metafield里添加FAQ数据；未创建Definition也可直接创建metafield（但无结构约束，不推荐）。

API端点（POST）

/admin/api/2024-07/shop/metafields.json

请求体示例（添加多个FAQ条目）：

{
  "metafield": {
    "namespace": "faq_app",
    "key": "store_faqs",
    "value": "[{\"question\":\"What's your return policy?\",\"answer\":\"We offer 30-day returns for unused items.\"},{\"question\":\"How long does shipping take?\",\"answer\":\"Standard shipping takes 3-5 business days.\"}]",
    "type": "list.object"
  }
}

2. 读取FAQ（Read） #

获取店铺下指定namespace和key的FAQ数据，或通过metafield ID获取单条。

方式1：按Namespace和Key查询（GET）

/admin/api/2024-07/shop/metafields.json?namespace=faq_app&key=store_faqs

返回结果包含存储的FAQ数组，直接解析value字段即可。

方式2：按Metafield ID查询（GET）

/admin/api/2024-07/metafields/{metafield_id}.json

3. 更新FAQ（Update） #

修改已有metafield的value字段，替换或新增FAQ条目。

API端点（PUT/PATCH）

/admin/api/2024-07/metafields/{metafield_id}.json

请求体示例（更新FAQ内容）：

{
  "metafield": {
    "value": "[{\"question\":\"What's your return policy?\",\"answer\":\"We offer 45-day returns for unused items.\"},{\"question\":\"How long does shipping take?\",\"answer\":\"Standard shipping takes 3-5 business days.\"},{\"question\":\"Do you ship internationally?\",\"answer\":\"Yes, we ship to over 50 countries.\"}]"
  }
}

4. 删除FAQ（Delete） #

若删除单个FAQ条目，需先读取现有数据，删除对应条目后再更新；若删除整个FAQ集合，直接删除对应的metafield即可。

删除整个FAQ集合的API端点（DELETE）

/admin/api/2024-07/metafields/{metafield_id}.json

三、注意事项 #

• API版本：示例使用2024-07版本，建议使用Shopify最新稳定API版本。
• 权限：应用需申请read_metafields和write_metafields权限，在Shopify Partner后台的应用设置中配置。
• 数据格式：使用list.object类型时，value必须是符合JSON格式的字符串，注意转义。
• 单条Metafield大小限制：Shopify对metafield的value大小有上限（通常为100KB），若FAQ条目过多，建议拆分到多个metafield或按分类存储。

内容的提问来源于stack exchange，提问作者SICT TechFreeze