smart-doc文档生成

最新推荐文章于 2024-08-10 07:58:01 发布

置顶 weixin_44019026

最新推荐文章于 2024-08-10 07:58:01 发布

阅读量688

点赞数

文章标签： boot maven

本文链接：https://blog.csdn.net/weixin_44019026/article/details/113548252

版权

1、pom依赖

<build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <mainClass>com.sxc.workflow.WorkflowBizWebApplication</mainClass>
                </configuration>
            </plugin>
            <plugin>
                <groupId>com.github.shalousun</groupId>
                <artifactId>smart-doc-maven-plugin</artifactId>
                <version>2.0.1</version>
                <configuration>
                    <!--指定生成文档的使用的配置文件,配置文件放在自己的项目中-->
                    <configFile>./src/main/resources/smart-doc.json</configFile>
                    <!--指定项目名称-->
                    <projectName>测试</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>package</phase>
                        <goals>
                            <goal>html</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

2、在resource目录下新建smart-doc.json文件

{
  "isStrict": false,
  "allInOne": true,
  "outPath": "doc/rpc",
  "projectName": "流程中心服务",
  "rpcApiDependencies":[{
    "artifactId":"workflow-api",
    "groupId":"com.sxc.workflow",
    "version":"1.0.0-SNAPSHOT"
  }]

}

3、如果是dubbo文档生成需要添加注解

/**
 * 处理任务相关操作
 *
 * @author zhouzhiwei 2021/1/13.
 * @version 1.0.0
 * @dubbo
 */


/**
     * 查询所有用户
     *
     * @return
     */

4、如果是web层

/**
 * 流程相关接口
 *
 * @author zhouzhiwei 2021/1/13.
 * @version 1.0.0
 * @restApi
 */
/**
     * 启动流程
     *
     * @return
     * @ignore
     */
@ignore 是不显示这个接口，此注解也可以加在实体类上

5、生成文档即可
在这里插入图片描述