Skip to content

Swagger 转 APISwagger 文档一键转 TS/JS API

基于 swagger-typescript-api 封装的 CLI 工具。从 Swagger JSON 快速生成 TypeScript / JavaScript 接口代码,多文档配置一站管理,响应结构可自定义提取。

30 秒上手 ​

按你的包管理器选一条安装,随后在项目目录执行:

sh
pnpm add -g @fxri/swagger2api
sh
npm install -g @fxri/swagger2api
sh
yarn global add @fxri/swagger2api
sh
# 交互式生成接口代码(npx/dlx 均需带作用域全名,裸写会拉取同名其他包)
npx @fxri/swagger2api

详细步骤见新手指南。

解决什么痛点 ​

痛点本工具的做法
后端 Swagger 文档到手,接口代码要手写一行命令从 Swagger JSON 生成 TS/JS 接口文件,含请求方法与类型定义
多个项目的接口配置散落,更新要挨个跑自动扫描全部 saconfig*.json,多选或一键全量更新
重名接口被加 _n 后缀,调用方看着懵地址 + 请求方法拼接唯一 operationId,从源头避免重名
每次生成都要重新确认一遍参数快速模式直接复用配置文件参数,一行命令静默更新

文档索引 ​

文档适合谁
新手指南第一次接触,想 30 秒跑起来
完整攻略日常使用:三种模式、响应提取、配置文件
CLI 参考查命令、参数、默认值
FAQ遇到问题先来这里找

环境要求 ​

  • Node.js >= 20

相关链接 ​

MIT 开源协议