本期推荐的是一个企业接口文档解决方案——torna。
Torna是一个企业接口文档解决方案，目标是让文档管理变得更加方便、快捷。Torna采用团队协作的方式管理和维护项目API文档，将不同形式的文档纳入进来，形成一个统一的维护方式。
Torna弥补了传统文档生成工具（如swagger）的不足之处，在保持原有功能的前提下丰富并增强了一些实用的功能：
- 基础：增删改查、预览文档、导入导出、文档排序、字典管理
- 增强：多环境调试、Mock数据、文档聚合、文档分享、权限管理、全局设置、docker运行、中英文切换、用户中心
- 扩展：Smart-doc推送、swagger插件推送、外部文档接入、OpenAPI/SDK推送
- 登录：第三方接口登录、LDAP登录、OAuth登录、钉钉免密登录
使用步骤：
方式1：下载zip本地运行
1. 准备工作
- Java环境，最低要求Java8
- MySQL，要求5.6.5及以后，5.6.5之前的版本见：支持低版本MySQL | Torna
2. 前往「链接」，下载最新版本，解压zip
3. 导入数据库，执行mysql.sql · tanghc/torna – Gitee.com
4. 打开application.properties配置文件，修改数据库连接配置
5. 执行sh startup.sh启动（Windows执行startup.bat）
6. 浏览器访问：http://ip:7700
7. 后续升级无特殊说明，只需要覆盖torna.jar文件和dist文件夹，然后重启即可
方式2：docker运行
1.下载公共镜像
docker pull tanghc2020/torna:latest2.导入数据库，执行mysql.sql · tanghc/torna – Gitee.com
3. 复制server/boot/src/main/resources/application.properties文件到/opt/torna/config下，修改数据库连接配置
4.执行docker run –name torna -p 7700:7700 -v /opt/torna/config:/torna/config -d <镜像ID>
5.浏览器访问：http://ip:7700
开发部署：
1. 开发环境
在着手开发之前，请您提前安装/学习如下环境
- Java8，Torna要求Java版本最低为Java8
- Maven3，包管理以及构建工具，最低版本要求maven3
- nodejs12，前端开发需要安装nodejs，建议版本12，版本太高可能会有问题
- Mysql5.7(推荐)
工程说明
- front: 前端工程
- plugin: 插件
- script: 辅助脚本
- sdk: OpenAPI对应的SDK
- server: 服务端工程
- mysql.sql：数据库脚本
2. 导入项目
本项目采用IDEA进行开发，Eclipse理论上也能支持。
由于Torna基于SpringBoot，因此完全可以使用社区版本的IDEA进行开发。
具体导入步骤如下：
- 导入MySQL脚本，MySQL5.6.5及以后的版本执行mysql.sql，5.6.5之前的版本见：支持低版本MySQL | Torna
- IDE安装lombok插件，然后打开项目(IDEA下可以打开根pom.xml，然后open as project)，初次导入会下载依赖包，请耐心等待
- 打开server/boot/src/main/resources/application.properties，修改数据库配置
- 运行server/boot/src/main/java/cn/torna/TornaApplication.java
至此，服务端启动完毕，下面讲解运行前端工程
运行前端
cd front，将命令提示符跳转到front目录
- 执行npm install
这一步是下载nodejs相关依赖
- 执行npm run dev，访问http://localhost:9530/
至此前端启动完毕
前端请求的服务器地址配置在.env.development文件中，默认是http://localhost:7700
IDE打开前端项目
使用WebStorm或VSCode打开front文件夹，如果您是后端Java开发人员，推荐使用WebStorm，界面熟悉一点，全家桶快捷键也一样。
界面预览：
文档管理
文档编辑
文档预览
接口调试
上传文件
更多内容大家可自行前往阅读。
开源地址：点击下载
如需项目推荐、获取资源请私信作者
