使用smart-doc自动生成接口文档

最新推荐文章于 2025-04-12 17:29:15 发布

晒干的老咸鱼

最新推荐文章于 2025-04-12 17:29:15 发布

阅读量752

点赞数

分类专栏：问题汇总文章标签： java json servlet

本文链接：https://blog.youkuaiyun.com/chali1314/article/details/125386187

版权

问题汇总专栏收录该内容

27 篇文章 ¥29.90 ¥99.00

订阅专栏

超级会员免费看

本文介绍了如何在Java项目中使用smart-doc来生成接口文档。首先在pom.xml添加smart-doc插件配置，然后创建smart-doc.json配置文件，最后通过执行mvn package命令生成接口文档，文档可在指定URL访问。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1、在pom.xml当中引入smart-doc的配置

在pom.xml的<build>标签的<plugins>标签下增加smart-doc的配置

<!--smart-doc begin-->
            <plugin>
                <groupId>com.github.shalousun</groupId>
                <artifactId>smart-doc-maven-plugin</artifactId>
                <version>2.3.6</version>
                <configuration>
                    <!--指定生成文档的使用的配置文件,配置文件放在自己的项目中-->
                    <configFile>./src/main/resources/smart-doc.json</configFile>
                    <!--指定项目名称，推荐使用动态参数，例如${project.description}-->
                    <!--如果smart-doc.json中和此处都未设置projectName，2.3.4开始，插件自动采用pom中的projectName作为设置-->
                    <!--<projec

了解本专栏