# springboot-smartdoc

**Repository Path**: caolmin/springboot-smartdoc

## Basic Information

- **Project Name**: springboot-smartdoc
- **Description**: springboot+smartdoc+torna实现代码接口文档生成、推送到torna
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 6
- **Forks**: 1
- **Created**: 2021-05-13
- **Last Updated**: 2023-07-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SpringBoot-SmartDoc

## 项目介绍

本项目通过smart-doc+torna 实现接口文档的自动创建与文档推送 

## 开发环境

````
    JDK 1.8 +
    Maven 3.5 +
    IntelliJ IDEA ULTIMATE 2018.2 + (注意：务必使用 IDEA 开发，同时保证安装 lombok 插件)
    PostgreSql 10+

````

## 软件安装及配置

+ torna 下载地址以及安装教程(建议下载最新版本1.6.3) [torna](https://gitee.com/durcframework/torna#%E4%BD%BF%E7%94%A8%E6%AD%A5%E9%AA%A4)
+ smart-doc maven插件配置 (建议使用最新版本2.1.7)  [smart-doc](https://gitee.com/smart-doc-team/smart-doc/wikis/smart-doc%20maven%E6%8F%92%E4%BB%B6?sort_id=1791450) 
+ spring-doc+torna对接 [spring-doc+torna](https://gitee.com/smart-doc-team/smart-doc/wikis/smart-doc%E4%B8%8Etorna%E5%AF%B9%E6%8E%A5?sort_id=3695028)

## smart-doc.json配置
模板示例

````
  "outPath": "G://smartdoc_demo", //必须 smart-doc输出路径
  "serverUrl": "http://127.0.0.1", //服务器地址,非必须。导出postman建议设置成http://{{server}}方便直接在postman直接设置环境变量
  "isStrict": false, //是否开启严格模式
  "packageFilters": "", //controller包过滤，多个包用英文逗号隔开
  "projectName": "startdoc-demo", //配置自己的项目名称 
  "appKey": "20210511841727963295645696", //torna平台对接appKey
  "appToken": "8ba4046aa4cf4d73b305ec40376abe9a",//torna平台appToken
  "secret": "hg~Z8!O@ZbDBt*95=,r%j=V6cR%o.tSu",//torna平台secret
  "openUrl": "http://localhost:7700/api",//torna平台地址，填写自己的私有化部署地址
  "debugEnvName":"测试环境",//torna测试环境
  "debugEnvUrl":"http://127.0.0.1:8091",//torna接口调试默认地址
  "author": "clm" //作者
  
````
详细配置参数可参考
+ [smart-doc+torna](https://gitee.com/smart-doc-team/smart-doc/wikis/smart-doc%E4%B8%8Etorna%E5%AF%B9%E6%8E%A5?sort_id=3695028)
+ [smart-doc](https://gitee.com/smart-doc-team/smart-doc/wikis/smart-doc%20maven%E6%8F%92%E4%BB%B6?sort_id=1791450)

## pom.xml配置

模板示例
````
<build>
    <plugins>
        <plugin>
            <groupId>com.github.shalousun</groupId>
            <artifactId>smart-doc-maven-plugin</artifactId>
            <version>2.1.7</version>
            <!--建议用最新版本-->
            <configuration>
                <!--指定生成文档的使用的配置文件,配置文件放在自己的项目中-->
                <configFile>./src/main/resources/smart-doc.json</configFile>
                <!--指定项目名称-->
                <projectName>SmartDoc-Demo</projectName>
                <!--smart-doc实现自动分析依赖树加载第三方依赖的源码，如果一些框架依赖库加载不到导致报错，这时请使用excludes排除掉-->
                <excludes>
                    <!--格式为：groupId:artifactId;参考如下-->
                    <!--1.0.7版本开始你还可以用正则匹配排除,如：poi.* -->
                    <exclude>com.alibaba:fastjson</exclude>
                </excludes>
                <!--自1.0.8版本开始，插件提供includes支持-->
                <!--smart-doc能自动分析依赖树加载所有依赖源码，原则上会影响文档构建效率，因此你可以使用includes来让插件加载你配置的组件-->
                <includes>
                    <!--格式为：groupId:artifactId;参考如下-->
                    <include>com.alibaba:fastjson</include>
                </includes>
            </configuration>
            <executions>
                <execution>
                    <!--如果不需要在执行编译时启动smart-doc，则将phase注释掉-->
                    <!--<phase>compile</phase>-->
                    <goals>
                        <!--smart-doc提供了html、openapi、markdown等goal，可按需配置-->
                        <!--<goal>html</goal>-->
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

````