MDN Web API 参考获取器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/mdn-web-api-reference-fetcher
技能介绍
这个技能解决什么问题
当你需要批量整理 Web API 文档时,直接抓 MDN 网页会遇到两个麻烦:页面是渲染好的 HTML,字段散落在标签里,用正则解析迟早会崩;不同 API 的兼容性表格格式也不统一,想比较 fetch 和 XMLHttpRequest 在各浏览器的支持情况,只能逐个页面人工抄录。MDN Web API 参考获取器针对的正是这个场景——把「读文档」变成一次结构化的数据获取。
它如何工作
该技能通过 MDN Yari 内容 API 拉取文档。Yari 是 MDN 站点后端的内容接口,返回的本身就是机器可读的 JSON,因此不需要 HTML 解析环节。核心能力包括三块:
- 结构化 API 签名:直接给出函数、接口、属性的名称与参数定义,省去从正文里抠签名的步骤。
- 浏览器兼容性数据:兼容性表来自 BCD(Browser Compat Data),可以按浏览器版本过滤,不必去读表格里的文字描述。
- 代码示例:页面中的示例代码一并返回,可直接入库或渲染。
典型流程是:指定目标 API 或页面 → 调用 Yari API 获取 JSON → 索引签名、BCD 数据与示例 → 存入你自己的知识库。
适用边界
需要注意几点:它只覆盖 MDN 文档范围内的 Web 标准 API,Node.js 专有模块、各浏览器独有的非标准接口不在数据源里;文档的时效性取决于 MDN 本身的更新频率,拿到的兼容性数据反映的是抓取时点的快照;另外 Yari API 没有公开的速率承诺,做大规模批量索引时要自行控制请求节奏。
使用场景
- 前端在决定是否使用某新 API 前,需要拉取其 BCD 兼容性数据确认浏览器支持情况
- 技术作者在整理 Web API 速查表时,需要批量获取 MDN 上的结构化签名与示例代码
- 团队构建内部文档镜像时,需通过 Yari 接口定时索引 MDN 页面以供离线检索
- 开发者写技术博客对比 `fetch` 与 `XHR`,要引用 MDN 最新兼容性表作为依据
适合人员
- 前端工程师,需要在编码前快速核对 Web API 的浏览器兼容性,避免线上兼容性故障
- 技术文档工程师,负责将 MDN 参考文档结构化入库,构建团队内部的 API 检索知识库
- 技术博客作者,撰写 API 对比或教程时需要准确的兼容性数据与官方示例代码作为素材
- 全栈开发者,搭建内部开发门户时需要集成 Yari API 来同步 MDN 文档内容