Java 接口转 TypeScript 类型生成器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_1d8afadc/sc-java-to-ts-interface。
技能介绍
解决的问题
后端 Java 接口文档通常混合了 RequestBody、嵌套 VO、PageResult、枚举、日期与金额字段,前端人工整理 TypeScript 类型时,容易漏掉字段、误改字段名,或把网关注入参数写进请求类型。该技能面向跨语言类型契约生成场景,把接口说明转成结构稳定、命名清晰、可复制到前端工程的 interface。
工作方式
- 解析输入:识别接口名称、地址、请求方式、参数位置与响应结构。
- 过滤参数:排除
LoginUser、userId、token等 Header 注入字段,避免污染请求类型。 - 类型转换:按映射表处理
Long、BigDecimal、Date、Map、Optional、MultipartFile等。 - 递归展开:嵌套
BO/VO/DTO生成独立interface,继承字段会合并到当前类型。 - 组装输出:生成请求体、查询参数、结果类型与分页类型,并用
JSDoc标注枚举值、日期格式和可选字段。
适用边界
它适合生成类型契约,不替代接口联调、字段校验或服务端变更。若字段可选性不明确,会默认必填并标记疑问;已有 ApiResponse 等通用类型不会被重复定义;输出不依赖表格,信息以列表和代码块表达。适合把后端字段说明沉淀为前端共享类型。
使用场景
- 后端给出 Java 接口文档,前端需要生成请求体和响应的 TypeScript 类型
- 接口包含嵌套 BO 和分页返回,需要递归展开为独立 interface
- 接口字段有枚举、日期、金额,需要在 JSDoc 中补齐格式说明
- 同一批接口文档需要输出成 Markdown,方便前端工程复用
适合人员
- 维护中后台前端代码的前端工程师,需要把后端字段说明沉淀为共享类型
- 对接支付或权益接口的全栈工程师,需要区分请求体、查询参数和分页结果
- 负责 API 联调的测试工程师,需要核对字段名、枚举值和日期格式
- 整理接口文档的架构师,需要生成命名统一、可评审的接口类型定义