用途:管理 Storefront Next 项目中可用的类型化 SCAPI 客户端,并在编写取数代码前发现 API 结构。
主要能力:两组互补命令。b2c sfnext scapi 管理项目内客户端是否存在,用于添加/移除 API、查看已配置项;b2c scapi schemas 浏览 API 形状(端点、字段、类型)。
使用方式:
- 管理项目客户端。列出可添加 API:b2c sfnext scapi available,可按 --api-family 过滤或加 --json。添加客户端:b2c sfnext scapi add product shopper-products v1,自定义 API 用 b2c sfnext scapi add custom my-loyalty-api v1,加 --force 可覆盖。列出当前客户端:b2c sfnext scapi list(可加 --json)。移除:b2c sfnext scapi remove product shopper-products,可减小打包体积。添加后客户端通过 createApiClients(context) 在 loader 中使用。
- 发现 API 形状(模式优先流程)。b2c scapi schemas list 查找 API 族/名称/版本;b2c scapi schemas get product shopper-products v1 --list-paths 查看端点;b2c scapi schemas get ... --expand-paths /products/{productId} 查看请求参数与响应结构,也可用 --expand-schemas Product 查看响应类型,并可组合使用。
适用场景:在 Storefront Next 中编写 loader 或 action 之前,先确认可用端点与参数结构,再基于发现的类型编写数据获取代码。
限制与注意事项:未检查 schema 就写 loader 易导致参数名错误或缺少必填字段;添加 API 后若客户端未出现,需运行 pnpm install 重新生成类型;自定义 API 需先部署并注册,否则 schema 可能返回空或 404;API 版本需用 scapi available 核对,避免类型与运行时行为不一致。相关技能包括数据获取、自定义 API、schema 命令参考与项目初始化。