讲师中心 微信公众号
AI工具推荐 视频效率加速

如何利用 TypeScript 高级类型(Mapped Types)实现类型安全的 API 封装

胖磊小哥_8443

胖磊小哥_8443

发布时间:2026-04-10 18:35:06

|

467人浏览过

|

来源于php中文网

原创

应使用映射类型(Mapped Types)显式建模「API路径→响应类型」的精确映射,而非 Record;需先定义字面量联合路径类型,再通过 keyof 和索引访问构建强类型客户端,确保调用时自动推导正确返回类型并拦截非法路径。

如何利用 typescript 高级类型(mapped types)实现类型安全的 api 封装

为什么直接用 Record<string any></string> 会丢失 API 响应结构信息

很多封装请求函数时图省事,把返回类型写成 Promise<record any>></record>,结果调用方完全不知道接口返回字段名、是否可选、嵌套层级。TypeScript 类型检查形同虚设,运行时才报 Cannot read property 'id' of undefined。

根本问题在于:你没把「接口路径 → 响应类型」的映射关系显式建模。Mapped Types 就是用来干这个的——它能基于一个键集合(比如 API 路径字面量)批量生成对应的响应类型,且保持每个路径绑定唯一、精确的类型。

  • 必须先定义所有合法 endpoint 的联合字面量类型,例如:type ApiPath = '/users' | '/posts/:id' | '/profile'
  • 不能用字符串拼接或动态 key,否则 TS 无法在编译期推导映射关系
  • 路径中的参数占位符(如 :id)要统一替换为泛型参数或提前规范化,否则类型无法对齐

用 Record<k t></k> + 索引访问类型实现路径到响应类型的静态映射

核心不是炫技,而是让 api.get('/users') 的返回值自动推导为 User[],而不是 any。关键在两步:定义路径-类型映射表,再用 Mapped Type 把它“展开”成对象结构。

示例结构:

interface ApiResponseMap {
  '/users': User[];
  '/users/:id': User;
  '/posts': Post[];
}

type ApiClient = {
  [K in keyof ApiResponseMap]: (path: K) => Promise<ApiResponseMap[K]>;
};

这样 client.get('/users') 的返回类型就是 Promise<user></user>,而传入非法路径(如 '/foo')会直接报错。

  • keyof ApiResponseMap 是字面量联合类型,TS 能精确识别每个 key
  • 不要把 ApiResponseMap 定义成 Record<string ...></string>,那会擦除 key 的具体值
  • 如果后端路径带 query 参数(如 /users?role=admin),类型上仍应以基础路径为准,参数校验交给函数重载或单独的 params 参数

处理动态路径参数(如 /users/:id)时怎么保留类型安全

直接写 '/users/:id' 会导致调用时传入 api.get('/users/123') 类型不匹配——因为 '/users/123' 不是 '/users/:id' 的子类型。需要把路径参数抽离,用函数签名承载。

Scrapfly SDK TypeScript
Scrapfly SDK TypeScript

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

下载

推荐做法:把带参数的路径定义为函数类型,而非字符串字面量:

interface ApiResponseMap {
  '/users': User[];
  '/users/:id': (id: string) => User;
  '/posts': Post[];
}

type ApiClient = {
  get<K extends keyof ApiResponseMap>(
    path: K
  ): K extends '/users/:id'
    ? (id: string) => Promise<User>
    : Promise<ApiResponseMap[K]>;
};

更实用的方案是拆成两个方法:get(path) 和 getWithParams(path, params),后者用泛型约束 params 结构(比如用 Extract<k></k> 触发条件类型分支)。

  • 别试图在字符串路径里做正则匹配或运行时解析,TS 类型系统不支持
  • 路径参数类型(id: number vs id: string)必须和后端实际接收类型一致,否则类型安全失效
  • 如果多个路径共享同一参数结构(如都含 :orgId),建议提取为 type PathWithOrgId = '/orgs/:orgId/members' | '/orgs/:orgId/settings',再用条件类型统一处理

为什么 as const 和 typeof 组合比手写字面量更可靠

手写 '/users' 容易漏、难维护。真实项目中,API 路径通常来自配置对象或后端文档生成的 JSON。这时要用 as const 锁定字面量类型,再用 typeof 提取键:

const API_ROUTES = {
  USERS: '/users',
  USER_DETAIL: '/users/:id',
  POSTS: '/posts',
} as const;

type ApiPath = typeof API_ROUTES[keyof typeof API_ROUTES]; // '/users' | '/users/:id' | '/posts'

后续所有映射类型(ApiResponseMap、ApiClient)都基于 ApiPath 构建,路径变更只需改 API_ROUTES,类型自动同步。

  • 没有 as const,API_ROUTES 的类型是 { USERS: string; ... },字面量信息就丢了
  • 如果路径来自外部 JSON 文件,需用 declare module '*.json' + as const 声明,否则无法保证类型精度
  • 别在映射类型里写 string 或 unknown 占位,那等于放弃类型安全的起点

最常被忽略的一点:Mapped Types 的类型推导深度有限。嵌套过深(比如三层以上条件类型嵌套)会让编辑器卡顿、报错模糊。遇到这种情况,优先拆分成中间类型别名,而不是硬塞进一个映射表达式里。

热门AI工具

更多
UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

5406

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

1329

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

5364

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

1000

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

1956

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

3765

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

4933

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

3240

2023.09.20

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

60

2026.10.28

热门下载

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

精品课程

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

共0课时 | 0人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.7万人学习

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

共21课时 | 1.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn