SuperAPI AI 工具集

context7

编程与开发

查看项目

更新于 10-16 06:38

技能介绍

用途

Context7 用于检索软件库、框架和组件的最新文档。它通过 curl 查询 Context7 API 来获取当前文档,适合在需要查阅库文档时替代可能已过时的训练数据。

主要能力

  • 通过搜索接口查找库的 Context7 库 ID。
  • 通过 context 接口按指定主题获取该库的文档。
  • 支持 json(默认)与 txt(纯文本,更易读)两种响应格式。
  • 基础使用无需 API 密钥,但存在速率限制。

使用方式

第一步:搜索库

查询搜索接口以找到 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:用于 context 接口的库标识符,例如 /websites/react_dev_reference。
  • title:人类可读的库名称。
  • description:库的简要描述。
  • totalSnippets:可用的文档片段数量。

第二步:获取文档

使用第一步得到的库 ID 检索文档:

curl -s "https://context7.com/api/v2/context?libraryId=LIBRARY_ID&query=TOPIC&type=txt"

参数:

  • libraryId(必填):来自搜索结果的库 ID。
  • query(必填):要检索文档的具体主题。
  • type(可选):响应格式,json(默认)或 txt(纯文本,更易读)。

示例

React hooks 文档:

# Find React library ID
curl -s "https://context7.com/api/v2/libs/search?libraryName=react&query=hooks" | jq '.results[0].id'
# Returns: "/websites/react_dev_reference"

# Fetch useState documentation
curl -s "https://context7.com/api/v2/context?libraryId=/websites/react_dev_reference&query=useState&type=txt"

Next.js 路由文档:

# Find Next.js library ID
curl -s "https://context7.com/api/v2/libs/search?libraryName=nextjs&query=routing" | jq '.results[0].id'

# Fetch app router documentation
curl -s "https://context7.com/api/v2/context?libraryId=/vercel/next.js&query=app+router&type=txt"

FastAPI 依赖注入文档:

# Find FastAPI library ID
curl -s "https://context7.com/api/v2/libs/search?libraryName=fastapi&query=dependencies" | jq '.results[0].id'

# Fetch dependency injection documentation
curl -s "https://context7.com/api/v2/context?libraryId=/fastapi/fastapi&query=dependency+injection&type=txt"

提示

  • 使用 type=txt 可获得更易读的输出。
  • 使用 jq 过滤和格式化 JSON 响应。
  • query 参数尽量具体,以提高相关性排序。
  • 如果第一个搜索结果不正确,请检查数组中的其他结果。
  • 对包含空格的查询参数进行 URL 编码(使用 + 或 %20)。
  • 基础使用无需 API 密钥(有速率限制)。

适用场景

适用于需要查阅软件库、框架或组件当前文档的开发场景,例如查询 React hooks、Next.js 路由、FastAPI 依赖注入等具体主题的文档。

限制

  • 基础使用存在速率限制。
  • 其他限制暂未提供。