一、添加依赖
<dependency>
<groupId>io.github.yedaxia</groupId>
<artifactId>japidocs</artifactId>
<version>1.4.4</version>
</dependency>
二、controller层注释
/**
* 两个参数的swagger例子,两个参数
* @param one 第一个参数注释
* @param two 第二个参数注释
* @return
*/
三、使用
在测试类中运行main方法,生成html离线文档,在本地运行项目时可以直接当方法写在springboot的启动类中
public static void main(String[] args) {
DocsConfig config = new DocsConfig();
config.setProjectPath("D:\\workSpace\\idea\\sbtest1"); // root project path
config.setProjectName("项目名称"); // project name
config.setApiVersion("V1.0"); // api version
config.setDocsPath("D:\\workSpace\\idea\\sbtest1\\apidoc"); // api docs target path
config.setAutoGenerate(Boolean.TRUE); // auto generate
Docs.buildHtmlDocs(config); // execute to generate
}
其中setProjectPath是项目根目录,setDocsPath是文档的生成目录