推送dubbo文档

假设dubbo模块结构如下：

【可选】Torna平台新增一个应用，单独存放dubbo文档

在dubbo api模块下添加maven插件

        <!-- smart-doc插件 -->
        <plugin>
            <groupId>com.ly.smart-doc</groupId>
            <artifactId>smart-doc</artifactId>
            <version>3.1.2</version>
            <configuration>
                <configFile>./src/main/resources/smart-doc.json</configFile>
            </configuration>
        </plugin>

在resources下添加smart-doc.json，内容如下：

{
  "outPath": "target/doc",
  "projectName": "商城项目",
  "packageFilters": "cn.torna.dubbo.api.*",
  "openUrl": "http://localhost:7700/api",
  "appToken": "909793ed06234f029c5e170d1afa7d2a",
  "debugEnvName":"本地环境",
  "debugEnvUrl":"http://127.0.0.1:8080",
  "tornaDebug": true,
  "replace": true,
  "showValidation": false,
  "rpcApiDependencies":[{
    "groupId": "com.xxx",
    "artifactId": "xx-service-api",
    "version": "1.0.0-SNAPSHOT"
  }]
}

参数说明:

• outPath：固定填这个不用变
• projectName：项目名称
• packageFilters：dubbo接口对应的package目录，多个用,隔开
• openUrl：Torna应用中的OpenAPI接口
• appToken：Torna应用中的OpenAPI token
• debugEnvName：固定这样填
• debugEnvUrl：固定这样填
• tornaDebug：是否开启调试，初次使用建议开启，后面稳定了关闭
• replace：是否替换文档，建议true
• showValidation：固定false
• rpcApiDependencies：dubbo模块依赖说明

cd到项目目录(根pom所在目录),然后输入命令进行推送

mvn -Dfile.encoding=UTF-8 smart-doc:torna-rpc -pl :dubbo-api -am