用途:该技能提供在 Storefront Next 项目中实现并消费自定义 SCAPI 端点的完整流程。自定义 API 让你在 B2C Commerce 上定义自己的 REST 端点,并像标准 SCAPI 客户端一样从 loader 和 action 调用,具备完整类型安全。
主要流程:创建自定义 API(cartridge)→ 部署并注册(b2c code deploy)→ 添加类型化客户端(sfnext scapi add)→ 发现 schema(scapi schemas)→ 从 loader 调用(createApiClients)。
必要用法:自定义 API 由 cartridge 中 schema.yaml、api.json 和 script.js 三个文件组成。部署并激活后,用 b2c code deploy ./my-cartridge --activate,并用 b2c scapi custom status 验证注册状态为 active。添加类型化客户端:b2c sfnext scapi add custom my-loyalty-api v1。发现端点:b2c scapi schemas get custom my-loyalty-api v1 --list-paths 或 --expand-paths。调用时通过 createApiClients(context) 得到 camelCase 属性,如 clients.myLoyaltyApi.getPoints({...});交互式场景可用 useScapiFetcher。
适用场景:Shopper 类型自定义 API 从店面 loader/action 调用,需 siteId;Admin 类型用于后台、批量任务。
限制:需先部署激活才能浏览 schema;Shopper API 认证用 ShopperToken,Admin 用 BearerToken;schema 变更后需重新部署并用 --force 重新添加客户端;未注册时会出现 404 或 schema 为空。原文未提供收费、价格或效果信息。