Torna 是一个开源的企业级 API 文档管理平台,致力于解决团队在 API 文档管理中遇到的各种痛点。它提供了从文档生成、管理、调试到 Mock 服务的完整解决方案,帮助开发团队提升协作效率,让 API 文档管理变得简单高效。
核心价值
统一的文档管理平台
Torna 将分散在各个项目中的 API 文档集中管理,支持多种导入方式:
- 自动生成:通过 IDEA 插件、CLI 工具或 Maven 插件,直接从代码注释生成文档
- 手动创建:支持在线编写 Markdown 格式的 API 文档
- 外部导入:支持导入 Swagger JSON/YAML、OpenAPI 3.0 等多种格式
多框架支持
无论你使用什么技术栈,Torna 都能轻松集成:
Java 生态
- Spring Boot / Spring MVC
- Dubbo RPC 框架
- Solon 轻量级框架
其他语言
- Python(Flask、FastAPI)
- Go
- .NET
- Node.js
高效的协作体验
- 在线调试:直接在浏览器中调试接口,支持多环境配置
- Mock 服务:前后端并行开发,自动生成 Mock 数据,支持高级条件匹配
- 版本管理:记录接口变更历史,轻松追踪版本演进
- 权限控制:完善的权限体系,确保文档安全
为什么选择 Torna?
1. 开源免费,持续迭代
Torna 社区版完全开源免费,代码托管在 GitHub,拥有活跃的开发团队和用户社区。企业版提供 AI 智能体、全局搜索等高级功能,满足更大规模团队的需求。
2. 部署简单,灵活扩展
支持多种部署方式,适应不同规模团队的需求:
- Docker 部署:一条命令即可启动
- 传统部署:支持 jar 包直接运行
- Kubernetes:支持云原生环境部署
- 一键脚本:Linux/Windows 快速安装
3. 提升开发效率
- 代码生成:根据文档自动生成 TypeScript 类型定义、前端请求代码等
- 模板定制:支持自定义代码生成模板
- 请求历史:保存调试记录,支持一键回放
- 字典管理:枚举字段统一管理,减少沟通成本
4. 智能化体验(企业版)
企业版提供更多智能化功能:
- AI 智能体:集成大语言模型,智能回答接口相关问题
- MCP 服务器:与 AI 助手深度集成,实现智能代码生成
- 全局搜索:全文检索接口文档,快速定位所需信息
- 格式导出:支持导出 OpenAPI 3.0、Postman、ApiFox 等格式
适用场景
前后端分离团队
前后端开发者通过统一的文档平台协作,前端可以提前使用 Mock 数据进行开发,后端专注于接口实现,互不阻塞。
微服务架构
将众多微服务的接口文档统一管理,提供全局的 API 视图,方便跨服务调用和系统维护。
企业对外开放 API
为合作伙伴提供标准化的 API 文档门户,支持权限控制和访问统计,展现专业形象。
新人培训
统一的文档入口帮助新员工快速了解系统架构和接口设计,缩短上手时间。
快速开始
请参考部署教程。
社区与支持
- 官方网站:Torna