SuperAPI AI 工具集

vtex-io-service-apps

通用与其它

查看项目

更新于 10-16 07:21

技能介绍

用途:在 VTEX IO 项目中开发需要后端逻辑的应用,包括 REST API 路由、GraphQL 解析器、事件处理器、定时任务,以及与 VTEX Commerce API 和外部服务的集成。

主要能力:以 Service 类(node/index.ts)作为后端应用入口,接收 clients、routes(含中间件链)、GraphQL resolvers 和事件处理器;每个中间件、解析器和事件处理器都可通过 ctx 访问 ctx.clients、ctx.state、ctx.vtex、ctx.body。客户端类型包括 JanusClient(VTEX 内部 API,基址 https://{account}.vtexcommercestable.com.br)、ExternalClient(非 VTEX API)、AppClient(其他 VTEX IO 应用路由)、InfraClient(VTEX IO 基础设施)和 MasterDataClient(Master Data v2 CRUD)。自定义客户端通过继承 IOClients 并用 this.getOrSet() 注册,首次访问时惰性实例化。

使用方式:所有 HTTP 通信必须经由 @vtex/api 客户端,禁止使用 axios、fetch、got、node-fetch 等原始 HTTP 库;客户端只能通过 ctx.clients 访问,不得用 new 直接实例化;客户端应保持为薄数据访问层,业务逻辑放在中间件或服务函数中;在 service.json 中配置路由与中间件链,并在 Service 入口统一装配 clients、routes、resolvers 和 events。

适用场景:构建 VTEX IO 后端服务应用、调用 VTEX Commerce API、集成外部服务、编写 GraphQL 解析器与事件处理逻辑。

限制:单个服务应用建议不超过 10 条 HTTP 路由,超出时应拆分为更小的微服务;容器内存上限 512MB。Manifest 与 builder 配置、GraphQL schema 定义、React 组件开发不在本技能范围内。