SuperAPI AI 工具集

fullstack-schema-sync

编程与开发

查看项目

更新于 10-16 08:49

技能介绍

用途:解决 schema 变更后类型如何端到端传播的问题,关注触发时机、跳过步骤导致静默失败的原因,以及在 CI 中提前发现类型漂移。不涉及 ORM/schema 基础,假定 schema 已存在。

主要能力:

  • 梳理“生成链”:Prisma(schema.prisma→prisma generate→Prisma Client,或用 zod-prisma-types 生成 Zod schema)、OpenAPI(后端 spec→openapi-typescript 生成 api.d.ts)、GraphQL(schema.graphql→graphql-codegen 生成类型)、tRPC(前端编译期推断,无需生成步骤)。
  • 迁移触发:提供 db:change 等脚本串联 migrate 与 generate;提示 prisma migrate deploy 不会执行 generate,需在构建或启动阶段补 generate。
  • CI 漂移校验:prisma migrate diff 对比 migrations 与 schema.prisma;prisma generate 后 git diff 检查生成文件是否已提交;启动服务后用 openapi-typescript 生成到临时文件再 diff;GraphQL 用 graphql-inspector introspect 后 git diff schema.graphql。
  • 提交策略:建议提交生成文件,并在文件头标注自动生成提示。

使用方式:npm 脚本(如 postinstall 执行 prisma generate)、Git hooks 校验、GitHub Actions 工作流;单体仓库可用 workspace 直接导入类型,独立仓库需发布 npm 包或在前端构建时从线上 spec 生成。

适用场景:Prisma/REST、Prisma/tRPC、Drizzle、Hasura、OpenAPI、GraphQL 等技术栈的前后端类型同步。

限制:需要先确定技术栈、API 契约格式、前端类型消费方式、仓库结构与迁移工作流;仅覆盖 schema 到类型的传播,不包含 schema 设计;具体价格、平台支持等资料暂未提供。