springboot集成smart-doc导出接口文档推送到torna

最新推荐文章于 2024-07-02 09:52:13 发布

mayday1102

最新推荐文章于 2024-07-02 09:52:13 发布

阅读量2.3k

点赞数 3

分类专栏： java smart-doc torna 文章标签： java

本文链接：https://blog.csdn.net/weixin_44158741/article/details/115728168

版权

本文介绍了如何在SpringBoot项目中集成Smart-Doc，生成接口文档并将其导出为HTML。同时，文章详细阐述了如何配置Torna，包括安装、数据库导入、设置配置文件等步骤。最后，讲述了如何将Smart-Doc生成的文档推送至Torna，并提供了相关配置的详细说明。

摘要由CSDN通过智能技术生成

smart-doc

点击跳转到官方文档

pom.xml添加依赖

<plugin>
    <groupId>com.github.shalousun</groupId>
    <artifactId>smart-doc-maven-plugin</artifactId>
    <version>2.1.3</version>
    <configuration>
        <!--指定生成文档的使用的配置文件,配置文件放在自己的项目中-->
        <configFile>./src/main/resources/smart-doc.json</configFile>
        <!--指定项目名称-->
        <projectName>测试</projectName>
        <!--smart-doc实现自动分析依赖树加载第三方依赖的源码，如果一些框架依赖库加载不到导致报错，这时请使用excludes排除掉-->
        <excludes>
            <!--格式为：groupId:artifactId;参考如下-->
            <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>