【springboot】替代swagger的新插件JApiDocs

前言

JApiDocs

使用步骤

注意事项
main方法需要和代码在同一目录。位置要求，类似springboot启动类。
缺点：该版本(1.4)不适用与微服务。需要入参的实体类与方法在同一项目。

1. 引入依赖

<dependency>
  <groupId>io.github.yedaxia</groupId>
  <artifactId>japidocs</artifactId>
  <version>1.4</version>
</dependency>

2. 执行main方法

DocsConfig config = new DocsConfig();
config.setProjectPath("your springboot project path"); // 项目根目录
config.setProjectName("ProjectName"); // 项目名称
config.setApiVersion("V1.0");       // 声明该API的版本
config.setDocsPath("your api docs path"); // 生成API 文档所在目录
config.setAutoGenerate(Boolean.TRUE);  // 配置自动生成
Docs.buildHtmlDocs(config); // 执行生成文档