阅读 12781
当 Swagger 遇上 Torna,瞬间高大上了!

当 Swagger 遇上 Torna,瞬间高大上了!

Swagger作为一款非常流行的API文档生成工具,相信很多小伙们都在用!用多了可能会觉得它界面丑、功能弱。今天给大家推荐一款工具Torna,配合Swagger使用可以搭建界面漂亮、功能强大的API文档网站,希望对大家有所帮助!

SpringBoot实战电商项目mall(50k+star)地址:github.com/macrozheng/…

Torna简介

Torna是一套企业级接口文档解决方案,可以配合Swagger使用。它具有如下功能:

  • 文档管理:支持接口文档增删改查、接口调试、字典管理及导入导出功能;
  • 权限管理:支持接口文档的权限管理,同时有访客、开发者、管理员三种角色;
  • 双模式:独创的双模式,管理模式可以用来编辑文档内容,浏览模式纯粹查阅文档,界面无其它元素干扰。

Torna项目架构

Torna是一个前后端分离项目,后端使用SpringBoot+MyBatis来实现,前端使用Vue+ElementUI来实现,技术栈非常主流!它不仅可以搭建API文档网站,还是个非常好的学习项目,让我们先来看看它的项目架构。

  • 下载成功后,将代码导入到IDEA中,项目结构如下;

  • 我们再来看下server模块的结构,一个非常标准的SpringBoot项目;

  • 再来看下front模块的结构,一个非常标准的Vue项目,值得学习!

安装

接下来我们把Torna运行起来,体验一下它的功能,这里提供Windows和Linux两种安装方式。

Windows

下面我们来介绍Torna在Windows下的安装方法,如果你想深入学习Torna的话可以采用此种方式。

后端运行

  • 首先创建一个数据库torna,然后导入项目中的mysql.sql脚本,导入成功后,表结构如下;

  • 修改项目的配置文件server/boot/src/main/resources/application.properties,修改对应的数据库连接配置;
# Server port
server.port=7700

# MySQL host
mysql.host=localhost:3306
# Schema name
mysql.schema=torna
# Insure the account can run CREATE/ALTER sql.
mysql.username=root
mysql.password=root
复制代码
  • 然后运行项目启动类TornaApplication的main方法,控制台打印如下信息表示启动成功。

前端运行

  • 进入前端项目目录front,运行npm install命令安装依赖;

  • 此时如果遇到node-sass无法安装的情况,可以直接使用如下命令安装;
npm i node-sass --sass_binary_site=https://npm.taobao.org/mirrors/node-sass/
复制代码
  • 依赖安装完成后,可以通过npm run dev命令启动项目,启动成功后访问地址:http://localhost:9530/

  • 通过体验账号密码admin@torna.cn:123456可以访问Torna服务,界面还是不错的!

Linux

在Linux下使用Docker安装Torna是非常简单的,如果你只想用Torna来做API文档服务的话可以采用这种方式。

  • 首先我们需要下载Torna的Docker镜像;
docker pull tanghc2020/torna:latest
复制代码
  • 下载完成后将配置文件application.properties拷贝配置文件到/mydata/torna/config目录下,并修改数据库配置;
# Server port
server.port=7700

# MySQL host
mysql.host=192.168.3.101:3306
# Schema name
mysql.schema=torna
# Insure the account can run CREATE/ALTER sql.
mysql.username=root
mysql.password=root
复制代码
  • 然后通过如下命令运行Torna服务;
docker run -p 7700:7700 --name torna \
-v /mydata/torna/config:/torna/config \
-d tanghc2020/torna:latest
复制代码

使用

Torna支持从多种工具导入接口文档,包括Swagger、smart-doc、OpenAPI、Postman等,接下来我们来体验下它的功能!

结合Swagger使用

Torna能大大增强Swagger的功能,并且界面足够美观,下面我们来体验下!

  • 在使用之前,我们需要在Torna中进行配置才行,首先我们来配置一个开放用户,新建一个macro的账号,记住AppKeySecret

  • 然后创建一个项目mall-tiny-trona

  • 接下来创建一个模块,打开OpenAPI标签,获取请求路径token

  • 之后在使用Swagger的项目中集成Torna插件,非常简单,添加如下依赖即可;
<!-- Torna Swagger 插件 -->
<dependency>
    <groupId>cn.torna</groupId>
    <artifactId>swagger-plugin</artifactId>
    <version>1.2.6</version>
    <scope>test</scope>
</dependency>
复制代码
  • 然后在resources目录下添加配置文件torna.json,配置说明参考注释即可;
{
  // 开启推送
  "enable": true,
  // 扫描package,多个用;隔开
  "basePackage": "com.macro.mall.tiny.controller",
  // 推送URL,IP端口对应Torna服务器
  "url": "http://localhost:7700/api",
  // appKey
  "appKey": "20211103905498418195988480",
  // secret
  "secret": "~#ZS~!*2B3I01vbW0f9iKH,rzj-%Xv^Q",
  // 模块token
  "token": "74365d40038d4f648ae65a077d956836",
  // 调试环境,格式:环境名称,调试路径,多个用"|"隔开
  "debugEnv": "test,http://localhost:8088",
  // 推送人
  "author": "macro",
  // 打开调试:true/false
  "debug": true,
  // 是否替换文档,true:替换,false:不替换(追加)。默认:true
  "isReplace": true
}
复制代码
  • 接下来通过调用SwaggerPluginpushDoc方法来推送接口文档到Torna;
@RunWith(SpringRunner.class)
@SpringBootTest
public class MallTinyApplicationTests {

    @Test
    public void pushDoc(){
        // 将文档推送到Torna服务中去,默认查找resources下的torna.json
        SwaggerPlugin.pushDoc();
    }

}
复制代码
  • 推送成功后,在接口列表将显示如下接口信息;

  • 查看一下接口的详细信息,还是很全面的,界面也不错!

  • 把我们的项目运行起来,就可以直接在上面进行接口调试了,调用下登录接口试试;

  • 如果我们想设置公共请求头的话,比如用于登录认证的Authorization头,可以在模块配置中进行配置;

  • 在后端接口没有完成前,我们如果需要Mock数据的话,可以使用Mock功能;

  • 这里我们对登录接口进行了一下Mock,当然你也可以使用Mock脚本,这下只要接口定义好,前端就可以使用Mock的数据联调了。

结合smart-doc使用

smart-doc是一款无注解侵入的API文档生成工具,具体使用可以参考《smart-doc使用教程》 ,这里介绍下它与Torna结合使用。

  • 首先修改mall-tiny-smart-doc项目的smart-doc配置文件smart-doc.json,添加如下关于Torna的配置;
{
  // torna平台对接appKey
  "appKey": "20211103905498418195988480",
  //torna平台appToken
  "appToken": "b6c50f442eb348f48867d85f4ef2eaea",
  //torna平台secret
  "secret": "~#ZS~!*2B3I01vbW0f9iKH,rzj-%Xv^Q",
  //torna平台地址,填写自己的私有化部署地址
  "openUrl": "http://localhost:7700/api",
  //测试项目接口环境
  "debugEnvName":"测试环境",
  //测试项目接口地址
  "debugEnvUrl":"http://localhost:8088"
}
复制代码
  • 由于smart-doc的Maven插件已经自带推送文档到Torna的功能,我们只需双击smart-doc:torna-rest按钮即可;

  • 接下来在Torna中,我们就可以看到相关的接口文档了,非常方便!

总结

当一种工具变得越来越流行,但是某些功能需求又满足不了时,往往会有一些增强工具产生,Torna对于Swagger来说正是这样一种工具。Torna的文档界面和调试功能明显比Swagger高大上多了,而且还增加了权限管理功能,文档的安全性大大增强,大家觉得不错的话可以尝试下它!

参考资料

官方文档:torna.cn/

项目源码地址

github.com/macrozheng/…

本文 GitHub github.com/macrozheng/… 已经收录,欢迎大家Star!

文章分类
后端
文章标签