java快速生成接口文档和CHM文件详细过程
工具:EasyCHM
预览效果图:
流程:
1.准备工作,添加接口相关信息
首先要在接口上添加相关注释信息,需要的信息包括:接口描述、参数名、参数描述等如:
/**
* 测试接口
* @param checkResult 结果值
* @return
*/
@PostMapping("/testApi")
public Result testComminterMethod(@RequestParam String checkResult) {
return Result.success("端口号:"+"-Test:"+checkResult);
}
如果返回的结果是实体类,如上代码中的return Result,需要在实体类中的字段上也添加注释,如:
/**
* 是否成功
*/
private boolean flag;//是否成功
/**
* 返回码
*/
private Integer code;//返回码
/**
* 返回消息
*/
private String message;//返回消息
/**
* 返回数据
*/
private T data;//返回数据
2.添加依赖
在项目额pom.xml中添加如下依赖:
<dependency>
<groupId>io.github.yedaxia</groupId>
<artifactId>japidocs</artifactId>
<version>1.4.3</version>
</dependency>
3.生成html页面
在任意类中添加main方法,在main方法中添加如下代码,可根据不同环境做出相应改变。
DocsConfig config = new DocsConfig();
// 项目根目录
config.setProjectPath("D:\\gwj\\project\\javaDocTest");
// 项目名称
config.setProjectName("ApiTest");
// 声明该API的版本
config.setApiVersion("V1.0");
// 输出API文档的目录
config.setDocsPath("D:\\gwj\\documents\\docs\\javaDoc2");
// 配置自动生成
config.setAutoGenerate(Boolean.TRUE);
// 执行生成文档
Docs.buildHtmlDocs(config);
运行main方法,会在控制台出现进度,如下图:
在输出目录会见到如下文件,把iosCodes和javaCodes删掉
4.修改html
在每个html中的顶部head标签中加入如下代码
<SCRIPT LANGUAGE="JavaScript">
<!-- Hide
function killErrors() {
return true;
}
window.onerror = killErrors;
// -->
</SCRIPT>
这段代码是屏蔽js错误弹窗的,不添加的话会一直弹窗。也有其他方法,暂时只说一种。
5.安装EasyCHM软件,把压缩包解压后会看到如下文件
双击echmsetup_CK.exe安装,安装好软件后,将补丁放在安装目录文件夹内,运行补丁软件,后即可使用软件。
6.启动EasyCHM软件,选择html目录
点击左上角新建,在弹出的窗口点击浏览, 选择html的目录,点击确定
7.编译
点击软件左上角的编译按钮。在弹出的窗口可以更改生成CHM的目录,不更改则生成在默认目录,然后点击生成CHM。
编译结束后在选择的目录中会生成CHM文件
生成html文件和CHM文件的方式有很多种,软件也有很多种,本文只讲其中一种。本文部分借鉴其他文章并加以完善,不足之处欢迎指出。
本文用到的软件:点击下方蓝字获取
EasyCHM
https://download.csdn.net/download/weixin_46801673/86503029
完全免费分享,设置的0币即可下载。或者:
链接:https://pan.baidu.com/s/1RFPnRlJVCbrpeSf8weG4Rg
提取码:2w4y