Swagger → TS Pro
v2+v3
就绪
📋 JSON 文本
🔗 URL 拉取
V3 示例
V2 示例
GET
POST
PUT
PATCH
DELETE
拉取
配置 Headers / Body
Headers (JSON 对象)
{ "Accept": "application/json" }
Body (POST/PUT/PATCH 时发送)
▼
🔍 过滤 (Tags / Paths / Methods)
Tags（点击切换：✓包含 · ✗排除 · ○忽略）
解析规范后将自动显示
Controller 白名单（逗号/正则/命名空间）
Controller 黑名单
Path 包含（逗号分隔，支持 * 通配）
Path 排除
Methods
GET
POST
PUT
DELETE
PATCH
OPTIONS
HEAD
输出
客户端
命名
美化
Mock
高级
输出模式
文件树 (tree)
单文件 (single)
生成范围
完整 (API + 类型 + Mock)
仅 API
仅类型
仅 Mock
拆分方式
按 Tag 拆分
按 Controller 拆分
按 Path 拆分
TS 生成器
自研引擎 (builtin)
openapi-typescript
类型文件名
API 目录名
生成类型文件
类型输出为 .d.ts
过滤未使用的类型
生成 Mock 文件
Enum 风格
联合类型 (union)
TS Enum
自定义 Mock 文件名
HTTP 客户端
Axios
Fetch API
Custom 自定义
自定义模块路径
Axios 调用风格 (Feature 16)
axios({method,url}) 配置对象
axios.get/post(url) 方法调用
Base URL
扩展配置 extendConfig (Feature 17，JSON 对象)
会覆盖 axios.create() 的默认配置，如 timeout / withCredentials / headers 等
API 前缀
默认 Content-Type
application/json
multipart/form-data
application/x-www-form-urlencoded
application/octet-stream
text/plain
text/xml
请求体可选
按 Schema required
始终可选 (?)
Content-Type 逐接口覆盖 (Map)
格式: /path:GET=multipart/form-data（每行一个）
返回值包装
无包装 (direct)
标准 { code, data, message }
自定义泛型
包装类型 (<T> 为占位)
函数命名方式
基于 Path 自动生成
使用 operationId
自定义模板
函数名模板
可用: {method} {Method} {METHOD} {path} {tag} {operationId} {summary}
函数风格
function 声明
箭头函数 const
文件名模板
命名风格 (Feature 19)
camelCase (小驼峰)
PascalCase (大驼峰)
强制唯一名
清理特殊字符 (:;/{} 等)
启用 Prettier 格式化输出
Tab Width
2
4
8
Print Width
Trailing Comma
all
es5
none
Semicolon
Single Quote
需要 CDN: unpkg.com/prettier/standalone + typescript plugin
Mock 引擎 (Feature 23)
基础类型 Mock (builtin)
Mock.js 语法模板
启发式生成 (根据字段名)
builtin: 根据 schema 类型生成静态值
mockjs: 生成 @string/@integer/@boolean 等模板
heuristic: name→名字, email→邮箱, url→网址等
HTTP 库名称 (httpLibraryName)
URL 统一前缀 (contentPath)
响应字段提取 (returnKey)
点号分隔的字段路径，从响应中提取
函数名后缀
URL 改写规则 (Feature 18)
JSON 数组格式，每项支持 from/to/flags
支持: 字符串映射 / 正则替换 / 函数 (function(url) => newUrl)
文件头注入代码 (leadingCode)
严格 Schema 校验 (Feature 24)
检查类型完整性、空对象定义、2xx schema 缺失等
过滤器高级语法说明
支持格式：
1. 字符串:
pet
— 精确匹配
2. Glob:
/pet/*
— 通配符匹配
3. 正则:
/^pet/i
— 正则表达式
4. 命名空间:
ns:/pet
— 限定命名空间
5. JSON 对象:
{"pattern":"pet","namespace":"api"}
⚡ 生成 TypeScript 代码
📋 复制全部
📋 复制当前
📦
粘贴 Swagger JSON 规范，配置参数，点击「生成」