Octri icon

Octri

Octri 将 OpenAPI、Swagger、Postman 或 AsyncAPI 规范转换为可编辑 API 文档、支持十种语言的可配置 SDK、MCP 工具及生产监控,帮助团队基于单一规范连接 API 交付与可观测性工作流。

Octri

基于单一规范的 API 工具

Octri 是一个开发者平台,可让 API 规范贯穿文档、SDK 生成、代理访问和生产监控流程。它支持多种常见的 API 描述格式,将其标准化为 OpenAPI 3.1,并使用生成的模型创建文档网站、客户端库、MCP 服务器和遥测工作流。

该平台旨在让这些输出与源规范保持关联。团队可以编辑生成的参考内容、编写独立指南、根据自身约定配置客户端,并在规范变更合并后重新构建。监控可以编译到生成的 SDK 中,也可以单独添加到后端,因此团队无需部署监控代理即可检查错误、追踪、服务关系、正常运行时间和回归问题。

核心能力

规范标准化

导入 JSON 或 YAML 格式的 OpenAPI 3.0 或 3.1、Swagger 2.0、Postman 或 AsyncAPI 文件,然后将其标准化为 OpenAPI 3.1,供后续产品使用。

API 文档工作室

生成可搜索的参考页面,直接编辑页面内容,添加 MDX 或可视化指南,并通过自定义域名发布。规范发生变更后,可以重新构建文档。

交互式文档

提供由 Schema 驱动的实时控制台,使用 API 的身份验证方式发送真实请求,并根据读者输入生成代码片段。搜索和可选的 AI 聊天功能可帮助读者查找答案。

可配置的 SDK 生成

为十种指定语言生成符合语言惯用方式的客户端库,并按语言配置命名、分页、幂等性、代码风格、传输方式和项目结构。客户端可以发布到软件包注册表。

SDK 与 API 监控

将遥测添加到生成的 SDK 中,或使用独立的后端软件包,而无需部署代理。监控提供结构化日志、分组问题、追踪、服务映射、N+1 查询检测、合成可用性检查和告警。

面向代理的 API 访问

以 Markdown 和 llms.txt 的形式发布文档,并将 API 端点公开为可调用工具,供 Claude、Cursor 和其他 MCP 客户端使用。可以从网站设置中禁用机器可读访问。

实际使用场景

  • 发布实用的 API 参考文档

    导入现有 API 规范,为其中的端点生成参考页面,然后修正描述、添加示例并发布面向读者的网站,无需读者直接处理源 YAML 文件。

  • 维护客户端库

    为每种目标语言配置命名、分页、幂等性、传输方式和文件夹约定,然后将生成的客户端发布到软件包注册表,并在变更发布时查看构建历史。

  • 让代理能够使用 API

    将同一 API 文档以渲染页面、Markdown 和 llms.txt 索引的形式公开,同时允许 Claude 或 Cursor 等 MCP 客户端将已记录的端点作为工具调用。

  • 调查生产环境中的 API 故障

    将遥测编译到生成的 SDK 中或安装后端软件包,然后通过分组问题、追踪、服务映射、查询检测、可用性检查和告警调查客户报告的故障。

Pros and Cons

Pros

  • 单一规范可以驱动文档、SDK、MCP 工具和监控工作流。
  • 生成的文档仍可编辑;除非被移除,否则手动编辑会在后续重新生成过程中保留。
  • 文档网站集成了参考页面、指南、搜索、实时请求控制台和机器可读内容。
  • SDK 输出支持十种语言及按语言配置的约定,无需团队分叉生成的客户端。
  • 监控可以包含在生成的 SDK 中,也可以添加到现有的后端软件包中;产品说明了客户端侧和数据接收时的脱敏功能。

Cons

  • 最详细的工作流和配置信息集中在 API 文档、SDK 生成、MCP 访问和监控领域;有这些领域之外需求的团队可能需要进一步验证其适配性。
  • AI 文档和聊天功能会消耗额度,SDK 语言额度因方案而异;部分层级中,额外语言需要付费添加。
  • 生成器和文档渲染器的客户自主管理部署仅限 Enterprise 方案。

FAQ

Octri 支持哪些规范格式?

Octri 支持 OpenAPI 3.0 和 3.1、Swagger 2.0、Postman 以及 AsyncAPI 规范,格式可以是 JSON 或 YAML。它会将输入规范标准化为 OpenAPI 3.1。在支持的情况下,您可以通过规范提供基础 URL 和身份验证方案。

Octri 如何处理生成的文档和编辑内容?

文档生成器会根据规范中的路径和方法创建参考页面。您可以生成整个 API、仅生成缺少文档的部分,或生成单个页面。生成的内容可以在发布前直接编辑;后续再次运行时,您的编辑会保留,除非您明确将其移除。

Octri 文档网站包含哪些内容?

发布的网站包括 API 参考页面、指南、搜索、实时 Playground 以及面向代理的可读索引。参考页面可以包含端点说明、字段描述、针对不同状态码的错误指导、可运行的 cURL、JavaScript 和 Python 示例,以及弃用提示。

有哪些 SDK 语言和配置选项可用?

SDK Studio 可为 TypeScript、Python、Go、Java、Dart、Ruby、PHP、Rust、Swift 和 Kotlin 生成客户端。它支持按语言配置命名空间、分页、幂等性、代码风格、HTTP 引擎、方法名称、排除的端点和文件夹结构等选项。自定义钩子也可以编译到客户端中。

Octri 是托管服务吗?是否有免费方案?

Octri 提供免费层级和付费方案。其中一个方案涵盖文档、SDK、监控和 MCP 服务器,但可用量和 SDK 语言额度因层级而异。Enterprise 方案可以在客户自行管理的基础设施中运行生成器和文档渲染器;其他层级由 Octri 托管。

Quick Facts

类别
开发者工具
主要输入
JSON 或 YAML 格式的 OpenAPI、Swagger、Postman 或 AsyncAPI
生成的输出
文档、SDK、MCP 服务器和监控工作流
SDK 语言
TypeScript、Python、Go、Java、Dart、Ruby、PHP、Rust、Swift 和 Kotlin
文档托管
托管的自定义域名网站;Enterprise 提供客户自主管理的渲染器
定价模式
免费层级加付费方案;其中一个方案涵盖文档、SDK、监控和 MCP
Octri - AI Tool, Features, Use Cases & Alternatives | UStack