现在使用ApiPost 生成接口文档
测试接口,生成接口文档一步到位,个人比较推荐
ApiPost官网:https://www.apipost.cn/
以下是原文
第一步:添加依赖
maven:
<dependency>
<groupId>io.github.yedaxia</groupId>
<artifactId>japidocs</artifactId>
<version>1.4</version>
</dependency>
第二步:配置参数
你可以在任意一个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); // 执行生成文档
第三步:添加注解
运行结果
官方文档:https://japidocs.agilestudio.cn/#/zh-cn/