快速开始

smart-doc官方目前已经开发完成Maven插件和Gradle插件，本章以Maven插件举例.

Gradle插件配置请跳转.

最小化配置

请保证你的代码格式符合最佳实践中的格式规范

在项目启动类所在模块的resources目录下创建smart-doc.json文件.

json

{
    "outPath": "/path/to/userdir"
}

outPath也可以使用相对路径, 如: ./src/main/resources/static/doc

在项目启动类所在模块的pom.xml文件配置Maven插件, 注意: 需要includes依赖的源码包

xml

<plugin>
    <groupId>com.ly.smart-doc</groupId>
    <artifactId>smart-doc-maven-plugin</artifactId>
    <version>[最新版本]</version>
    <configuration> 
        <configFile>./src/main/resources/smart-doc.json</configFile>  
        <projectName>${project.description}</projectName>  
        <includes>  
            <!-- 使用了mybatis-plus的Page分页需要include所使用的源码包 -->
            <include>com.baomidou:mybatis-plus-extension</include>
            <!-- 使用了mybatis-plus的IPage分页需要include mybatis-plus-core-->
            <include>com.baomidou:mybatis-plus-core</include>
            <!-- 使用了jpa的分页需要include所使用的源码包 -->
            <include>org.springframework.data:spring-data-commons</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>

includes中需要调整为项目模块所依赖的包配置artifactId:groupId, 支持正则artifactId:*
phase默认为compile，如果不需要在执行项目编译时启动smart-doc，则将phase注释掉

如果项目依赖其他内部公共模块和第三方包, 则使用maven-source-plugin插件生成源码包上传到内部私服中。 smart-doc自动根据依赖树自动下载源码包，然后进行文档生成。

xml

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-source-plugin</artifactId>
    <version>3.3.1</version>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <goal>jar-no-fork</goal>
            </goals>
            <configuration>
                <encoding>UTF-8</encoding>
            </configuration>
        </execution>
    </executions>
</plugin>

如何使用

在IDEA中直接使用Maven插件目录下的smart-doc模块
在命令行中执行

shell

mvn -Dfile.encoding=UTF-8 smart-doc:html
mvn -Dfile.encoding=UTF-8 smart-doc:markdown
mvn -Dfile.encoding=UTF-8 smart-doc:torna-rest
...

快速开始 ​

最小化配置 ​

如何使用 ​

快速开始

最小化配置

如何使用