同步操作将从 tanghc/torna 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
企业接口文档解决方案,目标是让文档管理变得更加方便、快捷。Torna采用团队协作的方式管理和维护项目API文档,将不同形式的文档纳入进来,形成一个统一的维护方式。
管理模式
和浏览模式
双模式,管理模式用来编辑文档内容,浏览模式纯粹查阅文档,界面无其它元素干扰演示地址 演示账号:guest@torna.cn
密码:123456
当前账号是访问者,只能阅读文档,可以自行部署到本地体验更多功能。
准备工作
前往 发行版页面 ,下载最新版本,解压zip
导入数据库,执行mysql.sql
打开application.properties
配置文件,修改数据库连接配置
执行sh startup.sh
启动(Windows执行startup.bat
)
访问:http://ip:7700
无特殊说明,只需要覆盖torna.jar文件
和dist文件夹
,然后重启即可
下载公共镜像
docker pull tanghc2020/torna:latest
导入数据库,执行mysql.sql
复制server/boot/src/main/resources/application.properties
文件到/opt/torna/config
下,修改数据库连接配置
执行docker run --name torna -p 7700:7700 -v /opt/torna/config:/torna/config -d <镜像ID>
浏览器访问http://ip:7700
体验账号:
密码均为:123456
超级管理员:admin@torna.cn
研发一部空间管理员:dev1admin@torna.cn
研发一部-商城项目(公开)-项目管理员:dev1shop_admin@torna.cn
研发一部-商城项目(公开)-开发者张三:dev1shop_zhangsan@torna.cn
研发一部-访客王五:dev1guest_wangwu@torna.cn
研发二部空间管理员:dev2admin@torna.cn
研发二部-后台项目(私有)-项目管理员:dev2back_admin@torna.cn
研发二部-后台项目(私有)-开发者李四:dev2back_lisi@torna.cn
研发二部-后台项目(私有)-访客:dev2back_guest@torna.cn
研发二部-访客赵六:dev2guest_zhaoliu@torna.cn
smart-doc + Torna实现文档全流程自动化
如果您使用Java语言,推荐使用smart-doc + Torna
smart-doc + Torna 组成行业领先的文档生成和管理解决方案,使用smart-doc无侵入完成Java源代码和注释提取生成API文档,自动将文档推送到Torna企业级接口文档管理平台。
通过这套组合您可以实现:只需要写完Java注释就能把接口信息推送到Torna平台,从而实现接口预览、接口调试。
推送的内容有:接口名称/author/Path参数/Header/请求参数/返回参数/字典列表/公共错误码
如果您是非Java语言,可以使用表单页面编辑以上内容,完成后同样可以进行接口预览、调试。
参见:开发文档
欢迎贡献代码,PR请提交到develop
分支
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。