一、说明        

        1、准备舍弃swagger了,拥抱smart-doc

        2、win10

        3、jdk8

        4、idea

二、搭建torna

1)下载zip

https://foruda.gitee.com/attach_file/1672544760054905357/torna-1.19.4.zip?token=25e02a8e2817a757a0aa47172349cc20&ts=1675345098&attname=torna-1.19.4.zip

2)也可以下载最新版

https://gitee.com/durcframework/torna/releases

3)创建数据库并导入初始化脚本

数据库: MySQL 5.6以上 库名: tonar

4)mysql脚本

https://gitee.com/durcframework/torna/edit/master/mysql.sql

5)启动即可

【Java】java | smart-doc + tonar | API文档统一管理_java

端口: 7700

账号: admin

密码: 123456

6)后台管理-创建用户

【Java】java | smart-doc + tonar | API文档统一管理_java_02

【Java】java | smart-doc + tonar | API文档统一管理_mysql_03

7)创造空间

【Java】java | smart-doc + tonar | API文档统一管理_java_04

8)创建项目

【Java】java | smart-doc + tonar | API文档统一管理_java_05

9)查看smart-doc的token

【Java】java | smart-doc + tonar | API文档统一管理_git_06

到此,配置完成

~~

 三、项目配置smart-doc

1)使用maven插件即可

2)配置示例

【Java】java | smart-doc + tonar | API文档统一管理_git_07

3)配置smart-doc.json

【Java】java | smart-doc + tonar | API文档统一管理_git_08

{
  "outPath": "src/main/resources/static/doc",
  "serverUrl": "http://127.0.0.1",
  "isStrict": false,
  "packageFilters": "",
  "projectName": "eladmin-java",
  "appToken": "0fe821154b134ec5b52ce56315c7afe7",
  "appKey": "",
  "secret": "",
  "openUrl": "http://localhost:7700/api",
  "debugEnvName":"测试环境",
  "replace": true,
  "debugEnvUrl":"http://127.0.0.1"
}

 4)通过插件生成doc

【Java】java | smart-doc + tonar | API文档统一管理_ide_09

5)推送成功示例

【Java】java | smart-doc + tonar | API文档统一管理_git_10

6)到torna刷新查看

【Java】java | smart-doc + tonar | API文档统一管理_java_11


真香~~~

7)smart-doc扩展了注解,了解一下

https://smart-doc-group.github.io/#/zh-cn/start/javadoc?id=smart-doc%e8%87%aa%e5%ae%9a%e4%b9%89%e6%b3%a8%e9%87%8atag

~~