企业版已发布，支持MCP调用，点击查看
English | 简体中文
接口文档解决方案，目标是让接口文档管理变得更加方便、快捷。Torna采用团队协作的方式管理和维护接口文档，将不同形式的文档纳入进来统一维护。
Torna弥补了传统文档生成工具（如swagger）的不如之处，在保持原有功能的前提下丰富并增强了一些实用的功能。
- 不满足swagger文档预览页面和调试页面的展现方式
- 不喜欢swagger这种侵入式注解
- 希望使用javadoc注释生成文档，并进行接口调试
- 希望把公司所有项目接口文档进行统一管理
- 希望把项目中的若干文档提供给第三方调用者查看
- 希望可以统一管理项目中的字典枚举
如果您有以上几个需求和痛点，或许可以尝试一下使用Torna
-
准备工作
- Java环境，最低要求Java8
- MySQL，要求5.6.5及以后，5.6.5之前的版本见：支持低版本MySQL
前往 发行版页面 ，下载最新版本，解压zip
导入数据库，执行mysql.sql
打开application.properties配置文件，修改数据库连接配置
执行sh startup.sh启动（Windows执行startup.bat）
访问：http://ip:7700
- 登录账号：
用户名：admin，密码：123456
- 后续升级
无特殊说明，只需要覆盖torna.jar文件和dist文件夹，然后重启即可
- 前提：导入数据库，执行mysql.sql
创建配置文件，执行命令：
mkdir /etc/torna && wget https://gitee.com/durcframework/torna/raw/master/install/application.properties -O /etc/torna/application.propertiesvim /etc/torna/application.properties修改数据库连接配置
拉取最新版本并启动
wget https://gitee.com/durcframework/torna/raw/master/install/restart-torna.sh && sh restart-torna.sh后续更新版本只需执行sh restart-torna.sh 版本号, 如:sh restart-torna.sh 1.35.2
导入数据库，执行mysql.sql
下载公共镜像
docker pull registry.cn-hangzhou.aliyuncs.com/tanghc/torna:1.35.2
创建配置文件，执行命令：
mkdir /etc/torna && wget https://gitee.com/durcframework/torna/raw/master/install/application.properties -O /etc/torna/application.propertiesvim /etc/torna/application.properties修改数据库连接配置
执行docker命令：
docker run --name torna --restart=always \
-p 7700:7700 \
-e JAVA_OPTS="-server -Xms512m -Xmx512m" \
-v /etc/torna/application.properties:/torna/config/application.properties \
-d registry.cn-hangzhou.aliyuncs.com/tanghc/torna:1.35.2
浏览器访问http://ip:7700，ip对应docker宿主机器ip，非docker容器ip
smart-doc + Torna实现文档全流程自动化
如果您使用Java语言，推荐使用smart-doc + Torna
smart-doc + Torna 组成行业领先的文档生成和管理解决方案，使用smart-doc无侵入完成Java源代码和注释提取生成API文档，自动将文档推送到Torna企业级接口文档管理平台。
通过这套组合您可以实现：只需要写完Java注释就能把接口信息推送到Torna平台，从而实现接口预览、接口调试。
如果您是非Java语言，可以使用表单页面编辑以上内容，完成后同样可以进行接口预览、调试。
- 开发文档
- Torna整合smart-doc教程
- Torna对应的示例工程 ，演示swagger插件的用法
- Torna整合smart-doc示例
欢迎贡献代码，PR请提交到develop分支
