🔥 前端开发福音,TS类型生成不用等!OpenAPI 转 TS 类型,Chrome 插件 + Node 服务双版本

51 阅读3分钟

谁需要这组工具?

  • 前端开发 / 接口联调:不想手动写 TS 类型定义,想从 OpenAPI/Swagger 自动生成?
  • 项目集成 / 自动化:需要在服务端批量生成类型文件,或对接 CI/CD 流程?
  • 快速验证 / 临时使用:只想粘贴地址一键生成,不想配置复杂环境?
  • 老项目重构 / 第三方 API 对接:需要高效同步接口类型,减少错误?

一款工具满足两种场景!Node.js 服务版 + Chrome 插件版,按需选择~


📌 核心功能总览(两款通用)

✅ 支持 OpenAPI 2.0 / 3.0+ 规范(Swagger 兼容)

✅ 自动生成 TypeScript 类型定义(.d.ts 文件)

✅ 支持指定 API 路径筛选(多路径用英文逗号分隔)

✅ 本地数据处理,无需上传服务器,隐私安全有保障

✅ 生成结果支持语法高亮、一键复制、文件下载


🔥 页面预览

image.png

🎯 分版本使用指南

一、Chrome 插件版(快速便捷,零配置)

适用场景:

临时使用、快速验证、非开发环境、不想部署服务

安装步骤(开发者模式):

  1. 下载项目:chrome 分支地
  1. 打开 Chrome → 输入 chrome://extensions/ → 开启「开发者模式」
  1. 点击「加载已解压的扩展程序」,选择项目根目录(含 manifest.json)
  1. 浏览器右上角出现插件图标,安装完成!

使用三步曲:

  1. 点击插件图标,粘贴 OpenAPI JSON 地址
  1. 可选:输入 API 路径(如 /pet,/user)筛选需要的类型
  1. 点击「生成 TypeScript」,复制 / 下载结果直接用!

二、Node.js 服务版(灵活集成,支持自动化)

适用场景:

项目内集成、批量生成、服务端部署、CI/CD 对接、多团队共享

环境要求:

  • 支持 fetch API 的运行环境(Node 18+ 内置支持)

安装 & 运行:

# 克隆项目(main 分支)
git clone https://github.com/jkhuangfu/types-generator.git
cd types-generator
# 启动服务(默认端口 9999)
node index.js

使用方式:

1. Web 界面(可视化操作)
  1. 服务启动后,访问 http://localhost:9999
  1. 输入 OpenAPI JSON 地址 + 目标 API 路径(多路径逗号分隔)
  1. 点击「请求并展示 d.ts」,复制 / 下载类型文件
2. API 接口(支持程序调用 / 自动化)

可通过接口对接其他系统,批量生成或定时同步类型,适合项目集成场景(具体接口可查看项目 README)


📋 版本对比 & 选型建议

特性Chrome 插件版Node.js 服务版
核心优势零配置、快速启动、浏览器内使用支持集成、批量处理、API 调用
部署成本无(本地加载)需 Node 环境,简单部署
适用场景临时使用、快速验证项目集成、自动化、多团队共享
扩展能力仅浏览器内使用可二次开发、对接 CI/CD

👉 选型建议:

  • 个人开发 / 临时需求 → 选 Chrome 插件版
  • 团队协作 / 项目自动化 → 选 Node.js 服务版(部署一次长期使用)

🌟 额外亮点

  1. 双版本共享核心转换逻辑,类型生成一致性高,切换无学习成本
  1. 支持复杂嵌套结构、枚举类型、可选参数自动识别,生成的 TS 类型精准
  1. 开源免费,可根据业务需求二次开发(如自定义类型命名、添加注释等)

立即体验!

有任何问题、需求或 Bug,欢迎去 Github 提 Issues 交流~ 让 TS 类型定义生成效率翻倍!