生成 API 文档
API Studio 根据 API 定义创建托管参考页面,涵盖端点、字段、嵌套字段、响应错误、弃用信息,以及可运行的 cURL、JavaScript 和 Python 示例。
Octri 是一个开发者平台,用于将 API 定义从规范转换为面向生产环境的工具。通过一个 OpenAPI、Swagger、Postman 或 AsyncAPI 源文件,它可以生成托管文档站点、客户端 SDK、供代理访问的 MCP 服务器,以及针对生成的 SDK 客户端的监控。该平台面向希望在规范发生变化时,让这些产物保持同步的 API 团队。
其文档产品将生成的参考资料与在线调试工具、搜索、AI 辅助文档和聊天功能,以及可供代理读取的索引相结合。其 SDK 产品最多可用十种语言生成客户端,并提供分页、流式传输、重试、超时、输出格式和请求钩子等选项。监控功能可跟踪问题,并针对生产客户端中观察到的问题配置提醒。
API Studio 根据 API 定义创建托管参考页面,涵盖端点、字段、嵌套字段、响应错误、弃用信息,以及可运行的 cURL、JavaScript 和 Python 示例。
查看一次生成将修改的内容,在发布前编辑参考内容,并在后续重新生成时保留这些编辑,除非你明确将其移除。
SDK Studio 根据同一份规范生成客户端库;其主页说明支持十种语言,并提供分页、流式传输、重试、超时、输出格式和请求钩子等控制选项。
已发布的文档包含 Markdown 内容、llms.txt 索引,以及作为可调用工具公开的端点。Octri 的产品方案还包括 MCP 服务器,用于将 API 能力连接到代理。
监控功能跟踪 SDK 客户端产生的问题,并支持配置提醒条件,包括 5xx 激增、新问题、回归、身份验证失败、延迟、速率限制和 Webhook 投递失败。
每个方案均提供 GitHub 同步;合并后的规范变更会重新构建草稿,并在发布前提供差异供审批。
API 团队可以将 OpenAPI、Swagger、Postman 或 AsyncAPI 文档导入 Octri,并发布带有可搜索参考页面、在线控制台、示例、架构和可供代理读取的索引。
通过 GitHub 更新规范的团队可以查看生成的差异,有选择地重新生成发生变化的页面,并在后续运行中保留手动编辑的说明。
团队可以根据 API 合约生成 SDK,配置分页和重试等客户端行为,并提供遵循同一源定义的特定语言方法。
开发者可以通过 MCP 工作流将已记录的端点公开为可调用工具,使代理能够搜索 API 文档并调用受支持的操作。
工程或运维团队可以使用客户端监控查看错误和回归问题,然后针对 5xx 响应、401 失败、延迟或 429 速率限制激增等条件配置 Slack 或 Webhook 提醒。
API Studio 接受 JSON 或 YAML 格式的 OpenAPI 3.0 和 3.1、Swagger 2.0、Postman 以及 AsyncAPI 文件。
可以。你可以在发布前编辑参考文档。Octri 会按页面存储编辑内容,后续重新生成时会保留这些编辑,除非你要求将其移除。
Octri 宣传支持十种语言的 SDK 生成。不同方案包含的语言数量不同,符合条件的付费方案可以按固定月费增加语言;Business 方案包含全部十种语言。
不需要。Octri 表示,一个方案涵盖全部四种产品。之后可以再启用它们,无需重新进行现有设置。
Enterprise 方案可以将生成器和文档渲染器运行在你自己的基础设施中。其他层级由 Octri 托管。
流量数据仅供参考。