粘贴 TypeScript 的 interface、type 别名、enum 或类声明,就能得到满足它们的示例 JSON 文档。字面量联合类型、Record、Pick、Omit、Partial 等工具类型,以及用 extends 串联的 interface 都会被跟踪并填充。
可以在 API 还不存在时准备 MSW 或 json-server 的 mock 数据、生成 Storybook 的 props,或者准确地向后端团队展示你希望他们发送的结构。
types.ts 之类文件中的类型声明。混有 export、import 和函数声明也没关系,只会读取类型声明。enum 也放进来,它们才会被填充。输入中缺失的类型名会变成 null。type UserPage = Page<User>)会优先于泛型声明本身。HttpResponse.json(...)、测试 fixture 或 Storybook 的 args 中,再调整值。type Channel = "email" | "sms" | "push";
enum Priority { Low = "low", High = "high" }
interface Notification {
id: string;
channel: Channel;
priority: Priority;
recipient: { userId: number; locale?: string };
payload: Record<string, string>;
readAt: Date | null;
meta: Pick<Audit, "createdBy">;
}
interface Audit { createdBy: string; createdAt: Date }{
"id": "",
"channel": "email",
"priority": "low",
"recipient": {
"userId": 0,
"locale": ""
},
"payload": {
"key": ""
},
"readAt": "1970-01-01T00:00:00.000Z",
"meta": {
"createdBy": ""
}
}Channel 是字符串字面量联合类型,所以取第一个值 "email";字符串 enum Priority 取第一个成员的值 "low"。Record<string, string> 变成只有一个 "key" 的对象,Date | null 取非 null 的一侧,成为 ISO 字符串,Pick<Audit, "createdBy"> 只保留选取的 key。可选的 locale? 也包含在内。
string → "",number/bigint → 0,boolean → false,any/unknown → null,Date → 1970-01-01T00:00:00.000Z(Date.toJSON() 的格式)。null/undefined 的成员,交叉类型(A & B)和 interface ... extends 会合并属性。enum 使用第一个成员的值;没有初始值的数字 enum 为 0。Array<T> 和 Set<T> 得到一个示例元素;元组按每个位置给出值;Record<K, V>、Map 和索引签名变成 {"key": V}。Partial、Required、Readonly、NonNullable、Pick 和 Omit 等工具类型。static 字段、get/set 访问器和 @Exclude() 字段会被排除。children: TreeNode[])会截断为空数组。在后端就绪之前,根据 API 响应类型生成 mock 数据。UI 可以先行开发,之后切换到真实 API 时仍沿用同样的类型。
根据组件的 props 类型创建默认对象,用作 story 的 args 或 React Testing Library 的渲染数据。所有必需属性都齐全,不会有类型错误需要追查。
把前端的请求类型转成 JSON,贴到 API 设计文档或 issue 中,不用 TypeScript 的后端开发者也能马上读懂结构。
?)总是会包含在内;要测试缺少这些属性的响应,请自行删除 key。type UserPage = Page<User>,items: T[] 会用 User 填充;没有传入参数时,会应用 <T = string> 这样的默认值。泛型内部的条件类型仍然不会被求值。T["key"] 这样的索引访问类型、条件类型和模板字面量类型不会被求值。name = "kim"、retries = 3)会使用该值;new Date() 等其他初始值只用来提示类型。z.infer 推断出的类型写成普通的 interface。Map 和 Set 分别显示为对象和数组,但 JSON.stringify 会把两者都变成 {},所以响应类型中最好使用 Record 或数组。Date 输出为字符串是对的吗?对。JSON.stringify 会用 toJSON() 的结果,即 ISO 8601 字符串,替换 Date。接收方拿到的仍然是字符串,所以要么声明为 string,要么自行解析。
status: "active" | "inactive" 这样的联合类型会取哪个值?按声明顺序的第一个字面量,即 "active"。如果想展示其他值,请调整联合类型的顺序。
类声明和装饰器都能解析,所以带有 class-validator 装饰器的 DTO 可以正常转换,class-transformer 的 @Exclude() 字段会被排除。
反方向请使用 JSON → TypeScript 页面。另外还有单独的页面,可以根据 TypeORM、Sequelize 和 Mongoose 模型生成 JSON。