You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

Notion API ^0.4.0 版本中如何使用 TypeScript 进行类型检查

Notion API 移除api-types文件后的类型检查方案
  • 使用官方SDK内置类型
    目前官方已经将全量API类型定义直接整合进了官方Node.js SDK @notionhq/client中,无需再单独引入独立的api-types包。安装最新版SDK后可直接导入所需类型,示例代码如下:

    import { Client, type Page, type Database, type CreatePageParameters } from "@notionhq/client";
    

    内置类型和官方API版本完全同步,覆盖所有请求、响应的结构定义,无需额外维护类型匹配逻辑。

  • 基于OpenAPI规范自行生成类型
    官方公开了完整的Notion API OpenAPI 3.0规范,你可以自行下载规范文件后,用工具生成适配自己项目的类型定义。常用生成工具可选openapi-typescript,生成命令示例:
    npx openapi-typescript 你本地存放的规范文件路径 -o notion-api-types.ts
    生成的类型文件可直接导入项目使用,也可根据业务需求裁剪不需要的接口类型。

  • 使用社区维护的第三方类型包
    如果你不使用官方SDK,也可以选择npm源中社区维护的notion-types等类型包,使用前注意核对包对应的API版本与你调用的API版本一致,避免出现字段不匹配的问题。

旧项目迁移提示:如果之前的项目依赖独立的api-types包,只需要把所有从api-types导入类型的语句,替换为从@notionhq/client导入对应类型即可,绝大多数接口命名没有调整,迁移成本极低。

内容的提问来源于stack exchange,提问作者Salvatore Argentieri

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.09.30 03:45:03