Torna

# 生成文档（solon）

本篇文章介绍如何推送solon (opens new window)项目接口文档到Torna

部署Torna

在Torna中新建一个项目，进入项目创建一个模块，输入模块名称

点击OpenAPI，可以看到请求接口和token

到此Torna这边配置完毕

solon项目根pom.xml添加插件：

    <plugin>
        <groupId>com.ly.smart-doc</groupId>
        <artifactId>smart-doc-maven-plugin</artifactId>
        <version>3.0.3</version>
        <configuration>
            <!--指定生成文档的使用的配置文件,配置文件放在自己的项目中-->
            <configFile>./src/main/resources/smart-doc.json</configFile>
            <!--指定项目名称-->
            <projectName>测试</projectName>
        </configuration>
    </plugin>

resources下新建文件smart-doc.json，内容如下：

{
  "framework": "solon",
  "outPath": "target/doc",
  "projectName": "商城项目",
  "packageFilters": "org.solon.demo.controller.*",
  "openUrl": "http://localhost:7700/api",
  "appToken": "1f716fabd15949eeb83ad3acf8fb6c4f",
  "debugEnvName":"本地环境",
  "debugEnvUrl":"http://127.0.0.1:8081",
  "tornaDebug": true,
  "replace": true,
  "showValidation": false
}

参数说明:

  • framework：固定填solon，指定solon框架
  • outPath：固定填这个不用变
  • projectName：项目名称
  • packageFilters：Controller接口对应的package目录，多个用,隔开
  • openUrl：Torna中的OpenAPI接口
  • appToken：Torna中的OpenAPI token
  • debugEnvName：Torna中调试环境名称
  • debugEnvUrl：Torna中调试环境地址
  • tornaDebug：是否开启调试，初次使用建议开始，后面稳定了关闭
  • replace：是否替换文档，建议true
  • showValidation：显示校验信息，建议false

对应关系如下图所示：

在项目根目录输入maven命令：mvn -Dfile.encoding=UTF-8 smart-doc:torna-rest

推送成功后，前往Torna查看文档是否生成

TIP

如果项目是多模块应用

在项目根目录输入maven命令：mvn -Dfile.encoding=UTF-8 smart-doc:torna-rest -pl :xxx -am

其中xxx表示子模块名，-pl :xxx -am表示推送哪个子模块

示例工程 solon-assembly-demo (opens new window)

← 对接MeterSphere →