前言¶
在前后端协作中,后端 Java 接口定义的变更容易导致前端类型定义滞后,需要手动同步或反复沟通确认。已有的做法通常是复制接口文档中的参数说明,手动编写 TypeScript 的 interface 或 type,工作量大且容易遗漏字段。
sc-java-to-ts-interface 针对这一场景,从后端 Java 接口文档直接生成前端可用的 TypeScript 类型定义,减少重复劳动。
是什么¶
sc-java-to-ts-interface 是一个 Skill,用于将后端 Java 接口文档转换为前端 TypeScript 类型定义(interface / type)。它由社区开发者 user_1d8afadc 发布,版本 1.0.2,分类为 dev-programming,当前评分 100000,累计下载 586 次,安装 6 次。
该 Skill 的输入支持多种格式:飞书文档、Spring Boot 接口文档、Swagger/OpenAPI、手写 API 文档等。输出为包含请求参数与响应结果的 .md 文件,文件中包含完整的 JSDoc 注释。
核心功能¶
- 从后端 Java 接口文档生成前端 TypeScript 类型定义
- 支持多种输入格式:飞书文档、Spring Boot 接口文档、Swagger/OpenAPI、手写 API 文档
- 输出包含请求参数与响应结果的 .md 文件
- 自动生成完整的 JSDoc 注释
- 支持触发关键词:Java 转 TS、接口转换、生成前端类型、接口文档转 TypeScript、DTO/VO/BO 转 interface、后端文档转前端类型、生成接口类型、类型定义生成
安装与启用¶
根据官方资料,该 Skill 的安装与启用方式以官方文档为准。当前暂无具体的安装命令、目录路径或配置项说明。
典型用法¶
当前资料中未提供具体的可复现用法示例。
适用场景与注意¶
适合需要从后端 Java 接口文档快速生成前端 TypeScript 类型定义的场景。使用时需提供格式符合要求的接口文档,输出为 .md 文件,可进一步转换为 TypeScript 类型定义。
结尾¶
sc-java-to-ts-interface 适用于从 Java 接口文档到 TypeScript 类型定义的自动化转换需求。更多详情请参考官方地址:
https://www.skillhub.cn/skills/user_1d8afadc/sc-java-to-ts-interface