
Octri:API 文档生成工具、SDK 与 MCP 平台
用一份接口规范生成文档、客户端 SDK 和 AI 代理工具。

Octri 是面向 API 开发团队的 API 文档生成工具与开发者平台。它以接口规范为共同来源,连接文档站、客户端 SDK、MCP 服务和运行监控,帮助团队维护对外开放的接口及其配套开发资料。
Octri 是做什么的?用通俗的话解释
假设你做了一个提供订单、支付或用户查询功能的 API,其他开发者想接入,就需要知道“调用哪个地址、传什么参数、会得到什么结果”。你通常还要为不同编程语言准备调用代码,并在接口变化时同步修改文档。
Octri 相当于把一份机器可读的“接口说明书”加工成三种可用成果:供人阅读的文档网站、供程序调用的 SDK,以及供 AI 助手读取和执行的 MCP 工具。监控模块则帮助你了解这些调用上线后在哪里出错。
它适合已有 API 和规范文件的 SaaS 团队、接口服务商及开发者平台维护者。实际接口、业务规则和生成内容的审核仍由团队负责;四个模块也可以按需要分别启用。
从 OpenAPI 规范生成可编辑的接口文档
API Studio 会依据规范整理端点说明、参数、请求体和响应结构,并提供请求示例。嵌套结构可以逐层展开,读者还能搜索文档、使用在线请求控制台。对于规范里不适合承载的内容,例如接入顺序、身份验证教程或版本迁移说明,可以另外编写 MDX 指南。
建议按一次完整接入流程开始:
- 上传规范文件,或连接存放规范的 GitHub 仓库。
- 检查端点名称、认证方式、请求参数和响应 schema,再生成文档。
- 对照实际 API 修订说明,补充必要的入门指南。
- 在测试环境用控制台执行一个正常请求和一个错误场景,确认示例可用。
- 配置发布信息;如需 SDK,再选择语言并连接对应的软件包仓库。
- 查看重新构建的草稿和差异,审核后发布。
在线控制台从读者浏览器调用 API,因此能否成功还取决于接口的 CORS 设置。GitHub 同步可触发更新,但“规范改变”不等于未经审核就把新 SDK 发布到生产使用的软件包仓库。
生成 10 种语言的 SDK,减少重复维护
SDK Studio 支持 TypeScript、Python、Go、Java、Kotlin、Ruby、PHP、Rust、Swift 和 Dart。团队可以调整方法名、排除内部端点、设置语言相关选项,再构建和发布客户端库。
这项能力适合需要同时服务前端、后端和移动端开发者的 API 团队。同一规范可以成为多份客户端代码的共同来源,降低分别维护接口定义的工作量。生成后仍应检查认证、分页及特殊响应等与你的服务密切相关的行为。
“支持 10 种语言”描述的是平台总能力,并不代表免费版能同时启用全部语言。自定义 SDK 代码也有套餐要求,官方将其列在 Growth 及以上方案中。
用 MCP 把真实接口提供给 AI 助手
Octri 的 MCP 服务提供 7 个文档工具,并可把被纳入范围的 API 端点转成可执行工具。Claude、Cursor 等 MCP 客户端可以读取已发布文档,查询实际参数,再使用配置好的接口能力。
阅读文档与执行请求的权限不同:只提供项目 ID 时,可以使用文档工具;执行实际 API 调用还需要相应凭据。官方说明凭据保留在运行 MCP 服务的机器上。配置时应明确目标环境、凭据权限和排除的端点,避免把内部操作暴露给不需要它的工作流。
上线后的监控,以及数据如何处理
监控模块可接收生成 SDK 或后端监控包上报的数据,提供日志、错误分组、请求追踪、可用性检查和告警。它默认关闭,启用后才把相应采集能力带入后续构建。官方说明数据会在客户端和接收阶段进行敏感信息遮蔽,但这不意味着可以忽略自己应用发送的内容。
官方隐私政策区分了不同处理路径:文档生成会发送相关规范内容给模型服务;文档问答会发送用户问题及匹配段落;搜索索引会处理文档文本以生成向量。Octri 声明自身及相关模型服务商不会用这些内容训练模型。这里应理解为受条款约束的云端处理,而非所有数据都留在本机。
免费版能做什么,什么时候需要付费?
以下为 2026 年 10 月 6 日核实的官网美元月付价格,付费标价未含税,不是人民币报价:
- Free:1 个项目、1 种 SDK 语言、50 个端点、每月 100 MB 监控接收量,以及一次性 100 个 AI 积分。
- Starter:49 美元/月,包含 2 种 SDK 语言。
- Growth:99 美元/月,包含 4 种语言,并提供版本管理及自定义代码、组件。
- Business:249 美元/月,包含全部 10 种语言及白标能力。
- Enterprise:按需求报价,可在自有基础设施运行生成器与文档渲染器;不要把这一点扩大成所有组件都能自行部署。
生成一个端点的文档或获得一次文档问答回复会消耗 1 个 AI 积分;手工编辑、SDK 构建和文档托管不按这套积分扣费。升级时应同时比较端点数、语言数和监控量,具体条件见官方套餐对比。
常见问题
Octri 免费版能实际发布文档吗?
可以,免费版包含自定义域名和 GitHub 同步。需要注意,100 个 AI 积分是一次性赠送,用完后 AI 生成与问答暂停,已发布文档、SDK 构建和监控仍可继续。
已有 Swagger 或 Postman 文件能导入吗?
官网列出了 OpenAPI 3.0/3.1、Swagger 2.0、Postman 和 AsyncAPI,支持 JSON 或 YAML 输入。导入后仍应检查转换得到的参数、认证与响应结构。
接口更新后,手工改过的说明会被覆盖吗?
官方说明人工修改保存在字段层,并在重新生成时保留;未修改的生成字段可以更新。发布前仍应查看草稿与差异,确认说明符合当前接口行为。
官方资源与开发者支持
- Octri 使用文档:查看接入、SDK 语言及 MCP 配置指南。
- Octri GitHub:查看公开软件包并反馈生成 SDK 的问题。
- 官方支持入口:查找产品、账单与常见故障的帮助。





