springboot maven整合smart-doc

最新推荐文章于 2023-06-27 18:10:31 发布

小小罗喽

最新推荐文章于 2023-06-27 18:10:31 发布

阅读量493

点赞数

分类专栏： API文档文章标签： maven java

本文链接：https://blog.csdn.net/Luohanghong/article/details/122211253

版权

本文介绍了如何将Smart-Doc与SpringBoot项目进行Maven整合，实现API文档的自动化生成。Smart-Doc可以无侵入地解析代码中的注释，提供详细的接口信息。通过配置Maven插件和smart-doc.json文件，可以轻松完成配置。

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

maven整合smart-doc

smart-doc对项目能够实现0代码侵入。smart-doc能够自动识别代码中标准注释参数信息。
官网地址：smart-doc官方文档

maven插件配置

 <plugin>
     <groupId>com.github.shalousun</groupId>
     <artifactId>smart-doc-maven-plugin</artifactId>
     <version>2.3.4</version>
     <configuration>
         <!--指定生成文档的使用的配置文件,配置文件放在自己的项目中-->
         <configFile>src/main/resources/static/smart-doc.json</configFile>
     </configuration>
     <executions>
         <execution>
             <!--如果不需要在执行编译时启动smart-doc，则将phase注释掉-->
             <phase>compile</phase>
             <goals>
                 <!--smart-doc提供了html、openapi、markdown等goal，可按需配置-->
                 <goal>html</goal>