将后端 Java 接口文档转换为前端 TypeScript 类型定义（interface / type）。输入：飞书文档、Spring Boot 接口文档、Swagger/OpenAPI、手写 API 文档等。输出：包含请求参数与响应结果的 .md 文件，含完整 JSDoc 注释。触发关键词：Java 转 TS、接口转换、生成前端类型、接口文档转 TypeScript、DTO/VO/BO 转 interface、后端文档转前端类型、生成接口类型、类型定义生成。
后端 Java 接口 → 前端 TypeScript 接口生成
功能概述
后端 Java 接口 → 前端 TypeScript 接口生成是一项面向实际任务的技能，主要用于解析输入 ：识别接口名称、地址、请求方式、请求参数（区分 Header/Body/Query/Path）、响应结构；过滤参数 ：排除 Header 注入参数（ LoginUser 、 userId 、 token 等网关/拦截器注入字段）；
核心要点
- 类型转换 ：按类型映射表将 Java 类型转为 TypeScript 类型。
- 它将相关步骤、工具调用和结果整理方式集中到统一流程中，帮助使用者更快完成目标并减少重复操作。
- 从功能定位来看，该技能强调把分散的操作要求整理成清晰、可复用的处理流程，使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。
使用与执行
实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数，再依据技能说明逐步执行；若输入条件不完整，应先补齐信息或采用保守配置，避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期，并对异常提示、缺失字段和边界情况进行处理；
结果检查与注意事项
涉及批量任务时，还应保存进度，避免中断后重复操作。该技能适合用于一次性任务，也可以接入自动化工作流，与其他技能或上层代理配合完成更完整的业务链路；在组合使用时，应明确每一步的输入输出关系，并避免不同步骤之间出现参数冲突。
后端 Java 接口 → 前端 TypeScript 接口生成
工作流程
- 解析输入：识别接口名称、地址、请求方式、请求参数（区分 Header/Body/Query/Path）、响应结构
- 过滤参数：排除 Header 注入参数（
LoginUser、userId、token等网关/拦截器注入字段） - 类型转换：按类型映射表将 Java 类型转为 TypeScript 类型
- 递归展开：嵌套 BO/VO/DTO 对象递归生成独立
interface - 组装输出：按固定格式输出接口概览 + TypeScript 代码块
- 标注疑问：信息不完整或有歧义时，在末尾以
> ⚠️ 注意：列出
类型映射
| Java 类型 | TypeScript 类型 | 备注 |
|---|---|---|
String / char / Character / UUID |
string |
|
int / Integer / short / Short / byte / Byte |
number |
|
long / Long |
number |
超大数值（如雪花 ID）用 string |
float / Float / double / Double / BigDecimal |
number |
高精度金额场景用 string |
boolean / Boolean |
boolean |
|
List / Set / Collection / T[] |
T[] |
|
Map / HashMap |
Record |
|
Date / LocalDateTime / LocalDate / Instant / ZonedDateTime |
string |
注释标注日期格式 |
byte[] / MultipartFile |
File |
文件上传场景 |
Object / JSONObject / JsonNode |
Record |
|
Optional |
映射为 T 并标记 ? |
|
void / Void |
— | 响应 result 为 null |
| 自定义 BO / VO / DTO | 生成对应 interface |
保留后端原始命名 |
| 枚举类 | 联合类型或 enum |
注释中列出所有枚举值 |
泛型包装处理
| 后端包装类型 | 展开方式 |
|---|---|
R / Result / Response |
使用项目通用 ApiResponse，不重复定义 |
PageResult / IPage / Page |
见分页模板 |
分页响应模板：
interface XxxPageResultBO {
/** 总记录数 */
total: number;
/** 数据列表 */
result: XxxItemBO[];
}
参数处理
| 参数位置 | 处理方式 |
|---|---|
Header（LoginUser、userId、token 等） |
忽略，不出现在请求类型中 |
| Body | 生成 {接口名}RequestBody |
| Query | 生成 {接口名}RequestParams |
| Path | 在地址中以 {param} 标注，在请求类型中单独体现 |
| FormData / MultipartFile | 生成 {接口名}RequestBody，文件字段类型为 File |
响应处理：
- 外层统一使用
ApiResponse（项目已有），不逐个生成 result实际类型单独定义为interface
命名规范
| 类型 | 命名格式 | 示例 |
|---|---|---|
| 请求体 | {接口名}RequestBody |
ClaimCreditRequestBody |
| 查询参数 | {接口名}RequestParams |
ListVideoRequestParams |
| 响应结果 | {接口名}ResultBO |
ClaimCreditResultBO |
| 分页结果 | {接口名}PageResultBO |
ListVideoPageResultBO |
| 嵌套对象 | 保留后端原始命名 | ClaimDetailBO |
注释规范
- 每个字段使用 JSDoc
/** ... */，内容来源于后端文档参数说明 - 可选字段用
?标记，必填字段不加 - 枚举值完整列出：
/** 奖励类型: BASIC_RETURN / DOUBLE_RETURN */ - 日期格式标注：
/** 过期时间，格式: yyyy-MM-dd HH:mm:ss */
输出格式
输出为一个 .md 文件，包含所有接口的完整定义。多个接口之间用 --- 分隔。
文件命名规则： {飞书文档标题}-接口类型.md，文档标题从飞书文档中提取。
单个接口结构模板
**接口名称** - **接口地址：** `/xxx/xxx` - **请求方式：** `POST` - **接口描述：** 一句话概括接口功能 - **请求参数：** （TypeScript 代码块：请求相关类型） - **响应结果：** （TypeScript 代码块：响应相关类型）
规则说明
- 标题使用
**接口名称**加粗文本，不使用#标题 - 接口地址、请求方式、接口描述为列表项
- 请求参数 和 响应结果 各自独立一个 TypeScript 代码块
- 请求参数代码块包含：嵌套子对象（请求侧） + 请求类型
- 响应结果代码块包含：嵌套子对象（响应侧） + 响应结果类型
- 无请求参数时，省略「请求参数」及其代码块
- 每个
interface之间空一行 - 所有接口输出到同一个
.md文件中，文件名由用户指定或根据模块名自动生成
禁止包含：装饰性分隔注释、ApiResponse 定义。
项目中已有的通用类型：
interface ApiResponse{ code: number; message: string; result: T; }
质量要求
- 不遗漏后端文档中的任何字段
- 字段名与后端完全一致，不擅自重命名
- 枚举值必须在注释中完整列出
- 日期/金额等格式化字段必须在注释中标注格式
- 接口描述总结为一句话，简明扼要
- 输出不得包含表格，所有信息使用列表或代码块
- 信息不完整或有歧义时，在末尾以
> ⚠️ 注意：列出疑问点
边界情况处理
| 场景 | 处理方式 |
|---|---|
嵌套泛型（如 List） |
展开为 Record |
继承关系（如 extends BaseDTO） |
将父类字段合并到当前 interface |
| 同名但不同模块的类型 | 加模块前缀区分 |
| 字段可选性不明确 | 默认必填，并在疑问点中标注 |
| 响应为纯数组（非分页） | result 类型为 XxxItemBO[] |
| 无请求参数 | 不生成请求类型 |
| 多种 Content-Type | 按实际类型生成，multipart/form-data 中文件字段用 File |
完整示例
详见 examples.md
热门AI工具
相关专题
本专题聚焦 Java 企业级系统中的多租户架构设计，讲解数据隔离策略、租户路由机制、数据库分库分表方案以及权限控制模型。通过真实 SaaS 系统案例，帮助开发者构建可扩展的多租户应用架构。
216
2026.06.29
本专题围绕Spring Boot 3中的响应式编程体系展开，系统讲解 WebFlux 的非阻塞模型、Reactive Streams、Mono 与 Flux 使用方式，以及在高并发场景下的性能优势。结合真实后端案例，帮助开发者构建低延迟、高吞吐的响应式服务架构。
180
2026.06.22
本专题围绕 Java 分布式系统中的事务一致性问题展开，系统讲解分布式事务的核心理论与解决方案。内容包括 Seata AT/TCC 模式原理、事务协调机制、服务调用链一致性保障以及高并发场景下的数据一致性设计策略。通过真实微服务案例，帮助开发者构建可靠的分布式事务处理体系。
161
2026.06.16
系统讲解 Java 中消息队列的集成与应用实践，涵盖消息队列的核心概念（生产者/消费者/Topic/Queue/Exchange）、RabbitMQ 的交换机类型与 Spring AMQP 集成、Kafka 分区/副本/消费者组机制与 Spring Kafka 配置、RocketMQ 事务消息与顺序消息、消息可靠投递（确认机制/持久化/重试）、消费端幂等性保障（唯一ID/去重表）、死信队列与延迟消息处理、消息积压监控与扩容策略，帮助开发
235
2026.05.18
系统讲解 Java 项目中缓存技术的选型与实践，涵盖本地缓存方案（HashMap 手动缓存/Guava Cache/Caffeine 高性能缓存）的使用与淘汰策略配置、Redis 数据结构（String/Hash/List/Set/ZSet）在缓存场景的应用、Jedis / Lettuce / Redisson 客户端选型、Spring Cache 注解（@Cacheable/@CachePut/@CacheEvict）的声明式缓存、缓
402
2026.05.15
聚焦 Java 应用的容器化与云原生部署，讲解 Dockerfile 编写规范与 Java 应用镜像构建、多阶段构建（Multi-stage Build）减小镜像体积、Jib / Buildpacks 免 Dockerfile 镜像构建方案、JVM 容器感知参数（-XX:MaxRAMPercentage）配置、Docker Compose 编排多服务（应用 + MySQL + Redis）、容器健康检查与资源限制、Kubernetes
280
2026.05.11
系统讲解 Java 项目构建工具的使用与进阶配置，涵盖 Maven 的 POM 文件结构、生命周期（clean/compile/package/install/deploy）与插件机制、依赖范围（compile/provided/test/runtime）与传递依赖管理、多模块聚合与继承、私有 Nexus 仓库发布，以及 Gradle 的 Groovy / Kotlin DSL 语法、Task 自定义与增量构建、依赖版本目录（Versi
229
2026.05.09
在 Java Stream 基础之上进一步深入函数式编程，涵盖 @FunctionalInterface 注解与自定义函数式接口设计、四种方法引用（静态/实例/对象/构造器）的使用场景、Lambda 中的 effectively final 变量捕获规则、函数组合（andThen/compose）与柯里化技巧、Comparator 链式比较器构建、CompletableFuture 异步函数式编排、Reactor / RxJava 响应
248
2026.05.08
热门下载
相关下载
精品课程
共0课时 | 0人学习
共0课时 | 0人学习
共0课时 | 0人学习
最新文章
