导出接口文档的形式还挺多的,目前我见过的有这几种吧,见下图:
图1(网页形式):
图2(md形式):
图3(word):
我目前遇到的新式也就这三种吧,当然还有pdf等形式,但是我们完全可以将word形式转化为pdf形式,那这个问题就解决了。如果有其他形式的,欢迎来指正哈!
咳咳,下面我就要详细介绍这些东西了
官方说明文档:JApiDocs Documentation
1.添加依赖:
<dependency>
<groupId>io.github.yedaxia</groupId>
<artifactId>japidocs</artifactId>
<version>1.4.3</version>
</dependency>
2.配置参数
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); // 执行生成文档
如果没有意外,执行完上面的代码后,你就可以在配置的目录中看到生成的文档了。
注意:
JApiDocs是通过解析Java源码来实现的,要使得JApiDocs正确工作,需要你在项目中的Controller
书写遵循一定的编码规范。
3.执行main函数:(项目根目录是绝对路径) 出现下图,则说明执行成功了
打开index.html文件。就可以看到所有的数据了
当然这个毕竟是html形式,所有有很多文件。你也可以转化为md形式。在main方法中添加代码,如下:
config.addPlugin(new MarkdownDocPlugin());
也可以转化为word形式和pdf形式。不过需要借助第三方工具【pandoc】
官网:http://www.pandoc.org
1.进入官网下载相关安装包
2.安装pandoc
点击运行.msi文件,打勾Accept…,然后点击Install。最后一步点击Finish之前记录一下安装路径。
Win+R快捷键输入cmd回车,打开cmd命令行,输入pandoc -v
出现类似如下信息证明安装成功:
如果未成功,可能需要配置环境变量,把刚刚记录的安装路径(C:\Users\Summer\AppData\Local\Pandoc\)加入环境变量。
3.转化
(1)md转docx。例子如下:
新建文本文件,输入pandoc -s test.md -o test.docx,保存成md2doc.bat文件。
代码中,test.md是你的md文件名,test.docx是将要转换成的docx文件名。
将你要转换的md文件与该bat文件放在一个目录下(每次转换前记得改bat文件里的md文件名),双击运行,docx文件就会出现在同个文件夹内。
按照上面例子就可以将我们刚刚弄好的md文件转化为word形式了。