name: context7 description: 通过 Context7 API 检索软件库、框架和组件的最新文档。此技能应用于查找任何编程库或框架的文档、寻找特定 API 或功能的代码示例、验证库函数的正确使用,或获取自训练以来可能已更改的库 API 的最新信息。
Context7
概述
此技能通过使用 curl 查询 Context7 API 来检索软件库和组件的当前文档。用它代替依赖可能过时的训练数据。
工作流程
步骤 1: 搜索库
要找到 Context7 库 ID,查询搜索端点:
curl -s "https://context7.com/api/v2/libs/search?libraryName=LIBRARY_NAME&query=TOPIC" | jq '.results[0]'
参数:
libraryName(必需):要搜索的库名称(例如,“react”、“nextjs”、“fastapi”、“axios”)query(必需):主题描述,用于相关性排名
响应字段:
id:上下文端点的库标识符(例如,“/websites/react_dev_reference”)title:人类可读的库名称description:库的简要描述totalSnippets:可用的文档片段数量
步骤 2: 获取文档
使用步骤 1 中的库 ID 检索文档:
curl -s "https://context7.com/api/v2/context?libraryId=LIBRARY_ID&query=TOPIC&type=txt"
参数:
libraryId(必需):来自搜索结果的库 IDquery(必需):要检索文档的特定主题type(可选):响应格式 -json(默认) 或txt(纯文本,更易读)
示例
React hooks 文档
# 找到 React 库 ID
curl -s "https://context7.com/api/v2/libs/search?libraryName=react&query=hooks" | jq '.results[0].id'
# 返回:"/websites/react_dev_reference"
# 获取 useState 文档
curl -s "https://context7.com/api/v2/context?libraryId=/websites/react_dev_reference&query=useState&type=txt"
Next.js 路由文档
# 找到 Next.js 库 ID
curl -s "https://context7.com/api/v2/libs/search?libraryName=nextjs&query=routing" | jq '.results[0].id'
# 获取应用路由器文档
curl -s "https://context7.com/api/v2/context?libraryId=/vercel/next.js&query=app+router&type=txt"
FastAPI 依赖注入
# 找到 FastAPI 库 ID
curl -s "https://context7.com/api/v2/libs/search?libraryName=fastapi&query=dependencies" | jq '.results[0].id'
# 获取依赖注入文档
curl -s "https://context7.com/api/v2/context?libraryId=/fastapi/fastapi&query=dependency+injection&type=txt"
提示
- 使用
type=txt以获得更易读的输出 - 使用
jq来过滤和格式化 JSON 响应 - 对
query参数要具体,以提高相关性排名 - 如果第一个搜索结果不正确,检查数组中的其他结果
- 对包含空格的查询参数进行 URL 编码(使用
+或%20) - 基本使用不需要 API 密钥(有限速)