代码拉取完成,页面将自动刷新
smart-doc-gradle-plugin在gradle多模块中的应用
在单模块和多模块项目中使用smart-doc-gradle-plugin
是不一样的。
对于单模块项目直接在项目的build.gradle
中添加smart-doc
的gradle
和配置即可。
而对于多模块则,你需要将smart-doc
的gradle
插件添加在根build.gradle
配置文件中。
然后在需要生成文档的模块中添加smart-doc所需要的json配置文件。
以本demo为例。demo-web-admin
的api依赖了model类模块core
。因此我们配置好后只能用
gradle的多模块构建命令在生成文档,就不要想着在IDEA上去点了,如果你们是成熟的团队,
文档生成的步骤直接放在CI的工具上去自动完成,这样smart-doc-gradle插件才能自动去加载core模块的源码。
我们使用命令操作看看结果
gradle :demo-web-admin:smartDocRestHtml
构建后插件输出可重要的信息
Smart-doc Starting Create API Documentation.
The loaded local code path is D:\workstation\iflytek-git\smart-doc-gradle-plugin-demo\demo-web-admin\src\main\java
The loaded local code path is D:\workstation\iflytek-git\smart-doc-gradle-plugin-demo\core\src/main/java
API Documentation output to D:\workstation\iflytek-git\smart-doc-gradle-plugin-demo\demo-web-admin/src/main/resources/static/doc
多模块请按照官方的操作来,请不要自己胡乱搞,项目模块之间额依赖要符合gradle的要求, smart-doc-gradle插件是没法通过gradle的api顺藤摸瓜找到模块间的依赖源码。
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。