134 Star 1.1K Fork 375

tanghc / torna

加入 Gitee
与超过 800 万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
readme_CN.md

Torna

English | 简体中文

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

Torna弥补了传统文档生成工具(如swagger)的不如之处,在保持原有功能的前提下丰富并增强了一些实用的功能。

当前版本号

模块 版本
sdk-java maven
swagger-plugin maven
smart-doc maven

使用步骤

方式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

  • 登录账号:

用户名:admin,密码:123456

  • 后续升级

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

方式2:docker运行

导入数据库,执行mysql.sql

下载公共镜像

docker pull tanghc2020/torna:1.16.1

下载完成后,执行docker命令:

docker run --name torna --restart=always \
  -p 7700:7700 \
  -e JAVA_OPTS="-Xms256m -Xmx256m" \
  -e MYSQL_HOST="11.11.11.11:3306" \
  -e MYSQL_SCHEMA="torna" \
  -e MYSQL_USERNAME="root" \
  -e MYSQL_PASSWORD="root" \
  -d tanghc2020/torna:1.16.1

需改更改的部分:

  • MYSQL_HOST:MySQL服务器地址
  • MYSQL_SCHEMA:数据库名称,默认不用改
  • MYSQL_USERNAME:MySQL用户名,要求账号能运行DDL/DML/ALTER语句
  • MYSQL_PASSWORD:MySQL密码

浏览器访问http://ip:7700,ip对应docker宿主机器ip,非docker容器ip

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分支

界面预览

文档管理

编辑接口

浏览文档

调试接口

沟通交流

一群(满) 二群

简介

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

发行版 (75)

全部

torna

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/durcframework/torna.git
git@gitee.com:durcframework/torna.git
durcframework
torna
torna
master

搜索帮助