Context7 REST API完全指南从搜索到获取文档上下文附限流与缓存最佳实践【免费下载链接】context7Context7 Platform -- Up-to-date code documentation for LLMs and AI code editors项目地址: https://gitcode.com/gh_mirrors/co/context7Context7 REST API 是 Context7 平台为开发者提供的文档接口只需一个 API Key就能通过GET请求按名称搜索代码库并获取经 LLM 智能重排的文档上下文Documentation Context直接喂给你的 AI 应用、代码助手或内部工具。本文面向新手带你从零走通「认证 → 搜索 → 取上下文」的完整流程并附上限流处理与缓存的最佳实践。为什么用 Context7 REST API文档常新Context7 持续解析开源仓库与网站文档你的 AI 拿到的永远是最新版本的 API 用法智能重排/v2/context接口返回的不是死板片段而是针对你的自然语言问题做过 LLM 相关性排序的代码块简单认证所有请求只需在请求头带上Authorization: Bearer 你的API密钥即可可观测仪表盘实时显示请求量、配额与费用方便控制成本完整的接口说明见 api-guide.mdx官方 API 文档入口为 docs/。第一步获取 API Key一键安装步骤登录 Context7 仪表盘打开API Keys卡片点击Create API Key给密钥起个描述性名字如CI pipeline、Cursor立即复制密钥——密钥只展示一次格式为ctx7sk-****...之后每个请求都带上请求头Authorization: Bearer YOUR_API_KEY⚠️ 密钥泄露或不用时请立即吊销吊销不可撤销。详见 api-keys.mdx。核心接口一搜索代码库Search for Libraries端点GET /api/v2/libs/search用于按名称找到目标库返回带id的结果列表这个id就是后续取上下文要用的Library ID。参数必填说明libraryName✅库名如react、nextjs、expressquery✅你的原始问题或任务描述用于 LLM 智能排序fast❌true时跳过 LLM 重排直接返回向量检索结果更低延迟技巧query写具体一点如 I need to manage state排序会更准。搜索接口文档见 search-for-libraries.mdx。核心接口二获取文档上下文Get Context端点GET /api/v2/context—— 这是整个 Context7 REST API 的「灵魂接口」。参数必填说明libraryId✅库 ID如/vercel/next.js、/websites/uploadcarequery✅自然语言问题如 How do I use useState?type❌返回格式txt默认或jsonfast❌true时跳过 LLM 重排换取更低延迟Library ID 速查就是 context7.com 上库页面的 URL 路径来源示例GitHub 仓库/vercel/next.js网站/websites/uploadcarenpm 包/packages/name指定版本/vercel/next.jsv15.1.8返回内容包括codeSnippets代码片段与infoSnippets说明性内容JSON 结构示例可在 get-documentation-context.mdx 与 OpenAPI 规范 openapi.json 中查看。其他实用接口一览方法端点用途POST/api/v1/refresh刷新某个库的文档POST/api/v2/add/repo/github等提交 GitHub/GitLab/Bitbucket 仓库解析POST/api/v2/add/website提交网站进行爬取GET/api/v2/libs/metrics查看库的使用指标GET/PATCH/api/v2/policies读写 Teamspace 策略企业私有化部署场景下还有解析状态查询、OpenAPI 规范导入等接口见 docs/enterprise/api/parse/。限流机制429 状态码与响应头超出速率限制时API 返回429 Too Many Requests并附带以下响应头帮助你自动恢复响应头含义Retry-After距离限流重置还需的秒数RateLimit-Limit窗口内总请求数上限RateLimit-Remaining当前窗口剩余请求数RateLimit-Reset限流重置的 Unix 时间戳限流最佳实践收到 429 时读取Retry-After等待后重试指数退避更稳无 API Key 时限制较低配置 Key 后按套餐获得更高额度在仪表盘实时查看用量与重置窗口见 usage.mdx缓存策略最省请求的最佳实践文档更新频率相对较低因此对响应做缓存是性价比最高的优化按小时/天缓存相同libraryId query的结果缓存数小时甚至数天可大幅减少 API 调用锁定版本用/owner/repoversion语法固定版本结果更稳定、缓存命中率更高查询具体化How to implement authentication with middleware 远优于 auth按需降级低延迟场景可加fasttrue跳过 LLM 重排牺牲少量相关性换速度用量与成本可在仪表盘 Overview 页跟踪错误处理常见状态码速查所有错误均返回{error: ..., message: ...}结构状态码含义你该做什么202库尚未解析完成稍后重试301库已重定向改用响应中redirectUrl的新 ID401API Key 无效检查密钥是否以ctx7sk开头404库不存在核对 Library ID409资源已存在该库此前已添加过429触发限流等Retry-After后重试5xx服务端问题指数退避后重试完整状态码表见 api-guide.mdx。总结 先拿 Key再调接口Bearer认证一步到位GET /v2/libs/search找库 →GET /v2/context取上下文两步完成️ 429 时读Retry-After指数退避重试 相同查询缓存数小时 锁定版本号请求量立降更多进阶内容可参考 TypeScript SDKsdks/ts/、API 总览api-guide.mdx与 overview.mdx把最新的文档上下文接入你的 AI 工作流吧【免费下载链接】context7Context7 Platform -- Up-to-date code documentation for LLMs and AI code editors项目地址: https://gitcode.com/gh_mirrors/co/context7创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考