Torna

# Swagger文档推送

使用条件：项目使用swagger注解声明文档

准备工作

  • 部署Torna
  • 安装maven并配置环境变量（执行mvn -v成功即可）

在项目根目录下创建 torna.yml 配置文件

# Torna 推送地址
url: http://localhost:7700/api
# Torna 推送 token
token: "xx"

# 是否使用swagger注解
useSwagger: true
# 调试模式，true：打印推送内容
debug: true

配置对应关系

img

# 推送文档

使用IDEA插件推送

支持IDEA版本：2023.3及以后

IDEA搜索插件Torna进行安装

img.png

如何使用：右键Java文件或包名

  • 方式1：右键Java文件点击 Push Doc（推送类中所有接口）
  • 方式2：右键包名 Push Doc（推送包下所有接口）
  • 方式3：打开Java文件，类名处右键 Push Doc（推送类中所有接口）
  • 方式4：打开Java文件，接口方法名处右键 Push Doc（推送当前接口）

img

← 推送dubbo文档 →