微信扫码
添加专属顾问
我要投稿
API文档与AI助手的高效协作,提升开发效率。 核心内容: 1. AI助手读取网页信息的挑战与Answer.AI的解决方案 2. LLMs.txt和Markdown格式如何优化AI对API文档的理解 3. Apifox集成LLMs.txt,一键复制和查看Markdown内容的方法
现在,很多 AI 助手都可以访问网络、直接读取网页信息。但是,现代网页内除了包含可读文本的 HTML 之外,还包含大量的 JavaScript 脚本。这些脚本是面向浏览器的,对于 AI 来说是无用的冗余信息,反而占用了 AI 对话的上下文长度,使 AI 响应变慢,而且让用户付出了额外的 Token 成本。
为了解决这个问题, Answer.AI 于 2024 年 9 月提出了一个方案:网站应该提供 Markdown 格式的内容,以便于 AI 读取。具体而言:网站上的每个网页都应该提供一个 Markdown 版本,其 URL 是给 HTML 页面的 URL 后添加.md
;此外,网站的根目录应该添加一个名为llms.txt
的 Markdown 文件,包含网站内每个 Markdown 页面的链接,以及一些简明扼要的信息。
可以认为,这个方案实现了网站对于 AI 的 SEO 优化,llms.txt
就是面向 AI 的sitemap.xml
。
LLMs.txt 能做什么
和 Apifox 上个月推出的 MCP-server" textvalue="MCP Server" linktype="text" imgurl="" tab="outerlink" data-linktype="2">MCP Server 一样,LLMs.txt 也是让 AI 助手访问 API 文档的一种优秀方案。对于不支持 MCP,或者无法读取网页的 AI 助手,我们现在可以直接以 Markdown 格式复制在线文档的内容,然后提供给 AI 作为上下文。
让 AI 高效、快速地理解和分析在线文档
AI 能以精炼的 Markdown 格式直接读取在线文档正文,摒弃冗余的 HTML 标签和无用的 JavaScript 脚本。由于输入内容简单明确,AI 可以更快地响应,而且能避免超出 AI 上下文限制,节省 Token。
根据 API 文档,辅助代码生成
Markdown 格式虽然简洁,但是包含了 API 文档的完整信息,即文本格式的描述和 YAML 格式的接口参数、数据模型等。因此,AI 可以精确地生成对应的请求代码、数据模型代码或者 MVC 代码等。
其他场景
请发挥你和你们团队的想象力...
如何在 Apifox 中启用 LLMs.txt
LLMs.txt 功能默认是开启的,无需额外设置,访问在线文档即可使用。
复制页面:一键复制当前页面的 Markdown 内容
以 Markdown 格式查看:直接查看当前页面的 Markdown 内容
llms.txt
索引文件如何让 AI 助手使用 LLMs.txt?
如何使用 LLMs.txt 及相关的 Markdown 文件?这里提供 2 种最常见的方法:
分享 Markdown 链接给可以访问 URL 的 AI 助手
.md
后缀,或者点击“以 Markdown 格式查看”,就可以得到对应页面的 Markdown 版本。对于能访问网络 URL,即具备 Web Browsing 能力的 AI 助手,可以直接将在线文档的.md
URL 提供过去,以便 AI 获取简洁、精炼的文档内容。
例如在腾讯元宝中,你可以这样提问:“请查看https://wn50ds108y.apifox.cn/api-205194698.md
获取宠物商店 API 的详细信息”。
在 Cursor 中,你可以这样提问:“理解这里的信息:@https://wn50ds108y.apifox.cn/api-205194698.md
,帮我生成一个 TypeScript 客户端代码”。
复制 Markdown 内容给无法访问 URL 的 AI 助手
此时,可以点击在线文档页面上的「复制页面」按钮,获取当前页面的 Markdown 内容,粘贴到与 AI 助手的对话内。
常见问题解答
如何关闭 LLMs.txt 功能?
开启 LLMs.txt 会对文档安全性产生影响吗?
如果我的在线文档设置了密码、IP 白名单、邮箱白名单等,能否使用 LLMs.txt 功能?
为什么我没有在 Apifox App 内看到“复制页面”等按钮?
我已经开启了 AI 助手的“联网搜索”功能,为什么 AI 无法通过 URL 读取网页内容?
AI 通过 URL 访问 Markdown 文件失败怎么办?
.md
文件里的内容给 AI。启用 LLMs.txt 后,我需要做什么额外工作吗?
如何验证 LLMs.txt 是否正常工作?
/llms.txt
路径,若能看到结构化的站点索引,则表明功能已正常启用。LLMs.txt 如何处理复杂的数据模型引用?
对 LLMs.txt 的支持,是我们在 API 文档与 AI 深度集成这个领域迈出的又一步。
全部 AI 助手,无论是否支持 MCP、是否支持联网,都可以读取简洁、精炼的 API 文档,深入理解 API 的参数定义,真正实现 AI 辅助开发的全方位支持。
通过 LLMs.txt 功能,你的 API 文档将成为 AI 理解你项目的理想载体,为开发效率带来质的飞跃,快去试试吧!
53AI,企业落地大模型首选服务商
产品:场景落地咨询+大模型应用平台+行业解决方案
承诺:免费场景POC验证,效果验证后签署服务协议。零风险落地应用大模型,已交付160+中大型企业
2024-03-30
2024-05-09
2024-07-23
2024-07-07
2025-02-12
2024-07-01
2024-06-24
2024-06-23
2024-10-20
2024-06-08
2025-04-13
2025-04-11
2025-04-03
2025-03-30
2025-03-28
2025-03-26
2025-03-13
2025-03-12