1 Star 0 Fork 181

xiaomo / torna

forked from tanghc / torna 
Create your Gitee Account
Explore and code with more than 6 million developers,Free private repositories !:)
Sign up
Clone or download
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
readme.md

Torna

企业接口文档解决方案,目标是让文档管理变得更加方便、快捷。Torna采用团队协作的方式管理和维护项目API文档,将不同形式的文档纳入进来,形成一个统一的维护方式。

特性介绍

  • 支持接口文档增删改查
  • 支持导入外部接口(支持导入swagger、postman)
  • 支持分享文档(匿名访问、密码访问)
  • 支持OpenAPI管理接口
  • 支持字典管理
  • 支持导出为markdown格式、html格式
  • 支持多环境接口调试
  • 支持Mock数据
  • 支持文档权限管理,访客、开发者、管理员对应不同权限
  • 支持第三方登录接入/OAuth认证登录
  • 支持钉钉免密登录
  • 支持设置全局请求头/请求参数/响应参数
  • 支持中英文切换(i18n)
  • 支持docker运行
  • 提供管理模式浏览模式双模式,管理模式用来编辑文档内容,浏览模式纯粹查阅文档,界面无其它元素干扰
  • 部署简单,直接运行脚本启动程序

演示地址 演示账号:guest@torna.cn 密码:123456

当前账号是访问者,只能阅读文档,可以自行部署到本地体验更多功能。

使用步骤

方式1:下载zip本地运行

  • 准备工作

    • Java环境,最低要求Java8
    • MySQL,要求5.6.5及以后,5.6.5之前的版本见:支持低版本MySQL

前往 发行版页面 ,下载最新版本,解压zip

导入数据库,执行mysql.sql

打开application.properties配置文件,修改数据库连接配置

执行sh startup.sh启动(Windows执行startup.bat

访问:http://ip:7700

  • 后续升级

无特殊说明,只需要覆盖torna.jar文件dist文件夹,然后重启即可

方式2:docker运行

下载公共镜像

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

docker-compose部署torna

【docker-compose方式部署torna】

kubernetes部署torna

【kubernetes部署torna】

推荐组合

smart-doc + Torna实现文档全流程自动化

如果您使用Java语言,推荐使用smart-doc + Torna

smart-doc + Torna 组成行业领先的文档生成和管理解决方案,使用smart-doc无侵入完成Java源代码和注释提取生成API文档,自动将文档推送到Torna企业级接口文档管理平台。

通过这套组合您可以实现:只需要写完Java注释就能把接口信息推送到Torna平台,从而实现接口预览、接口调试。

推送的内容有:接口名称/author/Path参数/Header/请求参数/返回参数/字典列表/公共错误码

如果您是非Java语言,可以使用表单页面编辑以上内容,完成后同样可以进行接口预览、调试。

开发部署

参见:开发文档

更新日志

changelog

参与贡献

欢迎贡献代码,PR请提交到develop分支

界面预览

文档管理

编辑接口

浏览文档

调试接口

沟通交流

About

企业接口文档解决方案,目标是让文档管理变得更加方便、快捷。Torna采用团队协作的方式管理和维护项目API文档,将不同形式的文档纳入进来,形成一个统一的维护方式。 spread retract
Java
Apache-2.0
Cancel

Releases

No release

Contributors

All

Activities

load more
can not load any more
Java
1
https://gitee.com/xmlvhy/torna.git
git@gitee.com:xmlvhy/torna.git
xmlvhy
torna
torna
master

Search

102255 3a0e046c 1850385 102255 7aaa926c 1850385