mcpField
B
backend-type-bridger

backend-type-bridger

github.com/heyeddi-com开发090 次安装1 天前更新
代码仓库

关于 backend-type-bridger

一项开发技能,可从本地 OpenAPI 文件生成 TypeScript API 类型,并可获取 Firebase 架构信息,适用于需要准确后端数据结构而非猜测字段的前端开发。

主要功能

  1. 01从 OpenAPI 生成 TypeScript 类型
  2. 02读取项目中的本地 OpenAPI 文件
  3. 03获取 Firebase Firestore 架构
  4. 04支持 FastAPI 类型同步

适用场景

  1. 01根据本地 API 规范生成前端类型
  2. 02实现 API 调用时核对数据结构
  3. 03为前端开发获取 Firebase 架构

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/heyeddi-com/heyeddi-skills --skill backend-type-bridger

安装后在 Claude Code 中输入/backend-type-bridger确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

manifest.json
context/
ANTI_PATTERNS.md
EXAMPLES.md
PROSE_ANTI_SLOP.md
VOCABULARY.md
scripts/
_skill_cli.py
fetch_firestore_schema.py
sync_openapi.py

详细介绍

后端类型桥接器

使用场景

  • 前端 Agent 需要准确的 API 载荷结构
  • 项目根目录下有本地 openapi.json(或其他 OpenAPI 文件)
  • Firebase 项目中存在 Firestore 规则或架构文件

说明

  1. 确保本地 OpenAPI 文件位于 openapi.json(项目根目录)。优先使用脚手架生成的文件。如果 API 正在运行,且该文件缺失或已过时,请先导出到磁盘(不要将 URL 传入此技能):

    curl -fsS http://127.0.0.1:8090/openapi.json -o openapi.json
    
  2. FastAPI 类型:python scripts/sync_openapi.py --project-root <root>:仅根据本地 openapi.json 生成 src/types/api.ts(可选使用 --openapi path/rel.json)。

  3. Firebase:python scripts/fetch_firestore_schema.py --project-root <root>

  4. 在组合式函数中导入生成的类型:切勿猜测字段名称。如果 OpenAPI 大量使用 $ref,请完善生成的接口。

评论

支持 Markdown