乐于分享
好东西不私藏

Torna:开源接口文档管理平台,一键把 Swagger 变成团队协作文档

Torna:开源接口文档管理平台,一键把 Swagger 变成团队协作文档

后端开发的日常里,接口文档管理是一个绕不开的环节。用 Swagger 吧,注解侵入太深;用 YApi 吧,项目已经停更了;

有没有一个开源免费的方案,既能管文档又能做调试?

Torna 就是干这个的。

Torna 是什么

Torna 是一个开源的企业级接口文档管理平台,Gitee 上 1.9K Star,Apache 2.0 协议完全开源。

它的核心定位很明确:不是生成文档的工具,而是一个集中管理接口文档的平台。你可以把 Swagger、smart-doc、Postman 导出的文档都导入 Torna 统一管理,也可以在平台上直接手写编辑。

用官网的话说:让接口文档管理变得更加方便、快捷。

它解决的痛点

  • • 用了 Swagger 但不满足它的展现和调试方式
  • • 不喜欢 Swagger 注解侵入业务代码
  • • 想把公司几百个接口统一管起来,而不是每个项目各有一套文档
  • • 需要把文档分享给外部对接方查看
  • • 想把项目中分散的字典枚举统一维护

这些场景,Torna 都覆盖了。

核心功能

文档集中管理

项目组的形式组织接口文档。不同业务线的项目之间接口互不干扰,每个项目组内可以创建多个服务模块。支持手动编辑、导入 Swagger JSON、导入 smart-doc 推送的文档,也能一键导出 OpenAPI 格式。

在线调试

Torna 内置了接口调试器,直接在文档页面上填参数、发请求、看响应。不需要切换到 Postman 或 curl。支持环境和全局变量,切换调试环境一键完成。

权限体系

三种角色:访客(只能看)、开发者(可编辑)、管理员(完全控制)。适合把文档分享给外部合作伙伴的时候使用。

字典枚举管理

统一管理项目中的字典和枚举。建一次,所有接口都能引用。改一处就行,不用每个文档都去改。

IDEA 插件推送

写完代码和注释,IDE 里一键推送到 Torna 平台。配合 smart-doc 用,注释写了文档就有了,全流程自动化。

支持 MCP

最新版已支持 MCP(Model Context Protocol),AI 助手可以直接读取 Torna 里的接口文档来生成代码和 Mock 数据。这个功能在同类型产品中还是比较少见的。


推荐组合:smart-doc + Torna

Torna 的官方推荐玩法是和 smart-doc 搭配。

smart-doc 负责文档生成——基于 Javadoc 注释自动提取接口信息,零侵入、不加注解。Torna 负责文档管理——接收 smart-doc 推送过来的文档,统一存储、展示、调试、分享。

整个流程是:

  1. 1. 写好 Javadoc 注释
  2. 2. Maven 构建时 smart-doc 自动提取文档
  3. 3. 推送到 Torna 平台
  4. 4. 团队成员在 Torna 上查看、调试、分享

这就实现了写注释 = 写文档的效果,不需要任何额外工作。

安装部署

Torna 的部署方式比较灵活:

本机运行: 下载 zip 解压,导入 MySQL,改一下数据库配置,执行 startup.bat/sh 启动,浏览器访问 http://ip:7700 即可。

Docker 部署: 官方提供了 Docker 镜像,一行命令启动。

docker-compose / Kubernetes: 项目里提供了完整的 compose 和 k8s 部署配置,拿来就能用。

技术栈上,后端是 Java(Spring Boot 系),前端是 Vue + Element-UI,团队里有 Java 开发就能自己二开。

适合什么样的团队

  • • 有多个后端项目需要统一管理接口文档
  • • 不想用 Swagger 注解侵入代码
  • • 需要把文档分享给外部团队查看
  • • 用了 smart-doc 想配一套文档管理平台
  • • 需要一个开源的替代方案替代 YApi
  • • 需要离线部署api接口管理的团队

总结

Torna 做的事不复杂:把接口文档集中起来管好。但它把这件事做得很扎实——权限、调试、字典、导入导出、插件推送、MCP 支持,该有的都有。

和 smart-doc 组合之后,从”写注释”到”生成文档”到”集中管理”到”在线调试”,一条完整的文档流就打通了。

如果你觉得 Swagger 的文档页面不够用,YApi 又不敢用来做新项目,Torna 是一个值得尝试的开源选择。


这篇文章如果对你有帮助,不妨点个赞感谢支持。

官网:https://torna.cn
仓库:https://gitee.com/durcframework/torna