如何通过 TypeScript 条件类型运算自动化推断复杂的 RESTful API 返回结构定义

雨雪酱_2709

雨雪酱_2709

2026-05-10

713人浏览

原创

直接用 typeof + as const 推静态样例最省事,但嵌套深、字段动态、含 Date 或 Buffer 时失效;必须用条件类型 + infer 解出 data 类型,否则接口与运行时脱节。

如何通过 typescript 条件类型运算自动化推断复杂的 restful api 返回结构定义

直接用 typeof + as const 推静态样例最省事,但遇到嵌套深、字段动态、含 Date 或 Buffer 的真实响应,它就失效了;这时候必须靠条件类型 + infer 从泛型中“捞”出 data 类型,否则接口定义会和运行时脱节。

用 DataOf 从统一响应结构里提取实际数据类型

多数项目后端返回结构固定:{ code: number; message: string; data: T }。手动写 AxiosResponse> 不仅啰嗦,还容易漏掉泛型层级。

  • DataOf 是个条件类型,只在 T 确实是 ApiResponse 形式时才解出 U,否则回退到 never
  • 别在 axios.get() 调用时传 ——那是错的,get 的泛型参数应填完整响应体类型,比如 >
  • 如果后端分页字段名不固定(比如有时叫 list,有时叫 items),infer 没法自动识别,得靠额外接口定义或运行时校验
type ApiResponse<t code: number message: string data: t type dataof extends apiresponse u> ? U : never;

// 正确用法
const res = await axios.get<apiresponse>>('/api/user');
type UserType = DataOf<typeof res.data>; // → User
</typeof></apiresponse></t>

处理字段名不固定或含非法标识符的响应

当 API 返回字段含空格、中划线(如 "user-id")、点号等 JS 非法属性名时,typeof 仍能推导,但后续访问必须用方括号语法,且 IDE 补全会变弱。

Scrapfly SDK TypeScript
Scrapfly SDK TypeScript

使用 Scrapfly SDK(scrapfly-sdk)在 TypeScript 或 JavaScript 中进行网页抓取,用于用户请求抓取 URL、绕过反爬虫防护、渲染页面等场景。

下载
  • as const 可保留字面量精度,但无法解决属性名合法性问题;字段名本身会被推为字符串字面量类型
  • 若需强类型访问,建议用 Record + 运行时 key 校验,或用 keyof + Record 显式枚举合法键
  • 避免在类型层面硬编码非法字段名,容易导致类型与运行时不一致

嵌套 Promise 或异步响应的类型解包

调用 fetch().then(r => r.json()) 后得到的是 Promise,直接 typeof 拿不到结构;需要先用条件类型把 Promise 层剥掉。

  • UnpackPromise 只解一层,DeepUnpack 支持递归解包(比如 Promise>)
  • 注意 response.json() 返回的是 Promise,必须配合 as Promise> 或类似断言才能触发 infer
  • 如果后端返回值含 Date 字符串(如 "2026-05-10"),TypeScript 无法自动转成 Date 实例,得靠运行时解析或自定义序列化类型
type UnpackPromise<t t extends promise u> ? U : T;
type DeepUnpack<t t extends promise u> ? DeepUnpack<u> : T;

// 示例
type Raw = Promise<apiresponse>>;
type Unpacked = DeepUnpack<raw>; // → ApiResponse<user></user></raw></apiresponse></u></t></t>

真正难的不是写对 infer,而是确认后端响应结构是否稳定——字段增删、嵌套层级变化、空值策略调整,都会让基于样例或泛型推导的类型瞬间过期。与其花时间补类型,不如推动后端提供可验证的 OpenAPI Schema。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

typescript restful api

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3589

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2428

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1380

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1318

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1416

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2338

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3860

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

18195

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.8万人学习

TypeScript——十天技能课堂
TypeScript——十天技能课堂

共21课时 | 1.8万人学习