2026-05-20 · 约 1 分钟阅读
用 JSON 生成 API 的 TypeScript 类型
把响应样例转成 interface,再在评审中统一命名。
TypeScriptJSONAPI
要点
- 使用含 null 字段的真实样例。
- 发布共享包前将生成名改为领域术语。
推荐流程
先格式化并校验 JSON,再以 ApiUser 等根名生成。
同一 payload 可用工具链 ?prefill= 跳转。
常见问题
混合数组会推断联合类型吗?
会——元素类型不同则输出联合类型数组。
生成类型要提交吗?
评审后提交;契约变更时重新生成。