Torna Cli

Torna CLI 是一个命令行工具，用于将 Java Spring MVC 项目的 API 文档推送到 Torna 平台。

项目地址：Torna Cli (opens new window)

功能特性

• 无需编译项目代码，上传速度翻倍
• 自动扫描 Spring MVC 源代码
• 推送 API 文档到 Torna 平台
• 支持多个源代码目录
• 灵活的配置文件支持

环境要求

• Java 8 或更高版本
• Maven 3.x

使用说明

在项目 src/main/resources 目录下创建 torna.yml 配置文件

# Torna 插件配置

# Torna 推送地址
url: http://localhost:7700/api
# Torna 推送 token
token: "xx"
# 推送人，如果为空，则获取当前电脑用户名
author: ""

# 扫描配置，可配置多个
## 前缀说明：
## package: 扫描包
## class: 扫描类，类全名
## method: 扫描方法，格式：类全名#方法名
## path: 扫描目录
scans: 
  # 扫描包下所有接口
  - "package:cn.torna.plugin.test.controller"
  # 扫描文件下所有接口
  # - "class:cn.torna.plugin.test.controller.UserController"
  # # 扫描单个接口
  # - "method:cn.torna.plugin.test.controller.UserController#postPage3"
# 调试模式，true：打印推送内容
debug: false

修改配置文件中的 url 和 token 为自己的 Torna 地址和 token。

前提条件

1. 本地安装 Java8 或更高版本
2. 本地安装 unzip 命令
3. 本地安装 curl 或 wget 命令

下载cli脚本torna-cli.sh (opens new window)

或者使用wget下载

wget https://gitee.com/durcframework/torna-cli/blob/main/shell/torna-cli.sh

添加执行权限：chmod +x torna-cli.sh

执行查看帮助

./torna-cli.sh -h

执行推送命令：

sh torna-cli.sh \    
-u http://localhost:7700/api \
-t 03de04f2104d41a2b6ced3c4afb22627 \
-s /Users/thc/Projects/torna-example/torna-and-smart-doc \
-f "class:cn.torna.example.web.controller.product.CategoryController" \
-a jim1 \
-d 

指定配置文件

sh torna-cli.sh \    
-c /Xx/xx/torna.yml \
-s /Users/thc/Projects/torna-example/torna-and-smart-doc \
-f "class:cn.torna.example.web.controller.product.CategoryController" \
-a jim1 \
-d 

参数说明

参数	简写	说明	是否必填
--src	-s	源代码目录，多个目录用逗号分隔	是
--configFile	-c	配置文件路径	否
--url	-u	Torna 平台地址	否
--token	-t	Torna 平台 token	否
--author	-a	作者名称	否
--debug	-d	调试模式	否
--help	-h	显示帮助信息	否
--version	-V	显示版本信息	否
--file	-f	配置文件内容	否