跟大家介绍一个自动生成接口文档的工具包，作者的理念是注释即文档，在写代码的时候写上注释，项目启动后就会生成接口文档，非常方便，省去了Swagger写注解的过程。

仓库地址：https://github.com/YeDaxia/JApiDocs

中文文档：https://japidocs.agilestudio.cn/#/zh-cn/

1.依赖

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

2.启动类添加生成代码

public static void main(String[] args) {DocsConfig config = new DocsConfig();config.setProjectPath("D:\\Project\\japidocs"); // 项目根目录config.setProjectName("ProjectName"); // 项目名称config.setApiVersion("V1.0");       // 声明该API的版本config.setDocsPath("D:\\Project\\japidocs\\docs"); // 生成API 文档所在目录config.setAutoGenerate(Boolean.TRUE);  // 配置自动生成Docs.buildHtmlDocs(config); // 执行生成文档SpringApplication.run(JapidocsApplication.class, args);
}

3.项目启动后控制台会出现这样的信息，然后在docs文件看到生成的文档

该工具的用法

定义一个类

class Test1 {/***  参数1*/private int a;private String b; // 参数2private Date c;
}

定义一个接口

@PostMapping("/test-3-post1")public Test1 test3post(@RequestBody Test1 test ) {return test;}

生成的文档

往接口上面添加注释

/*** 这个接口是干嘛的* @description 这是一行说明 哈哈哈~~~~* @param test 这是个对象 true* @author lkz* @return 一个类*/@PostMapping("/test-3-post1")public Test1 test3post(@RequestBody Test1 test ) {return test;}

生成文档

get请求

/**** @param path* @param a* @return*/@GetMapping("/test-5-get213/{path}")public String test5ge2t3(@PathVariable(value = "path", required = false) Integer path,@RequestParam(value = "a", required = false) String a) {return String.valueOf(path) + a;}

生成文档

/**** @param path* @param a* @return 一个String*/@GetMapping("/test-5-get213/{path}")public String test5ge2t3(@PathVariable(value = "path", required = true) Integer path,@RequestParam(value = "a", required = true) String a) {return String.valueOf(path) + a;}

生成文档

侧边栏

这里的显示支持html标签

/*** 这个接口是干嘛的 <span class="label label-warning">POST</span>* @description 这是一行说明 哈哈哈~~~~* @param test 这是个对象 true* @author lkz* @return 一个类*/@PostMapping("/test-3-post1")public Test1 test3post(@RequestBody Test1 test ) {return test;}/*** get请求 <span class="label label-warning">GET</span>* @param path* @param a* @return 一个String*/@GetMapping("/test-5-get213/{path}")public String test5ge2t3(@PathVariable(value = "path", required = true) Integer path,@RequestParam(value = "a", required = true) String a) {return String.valueOf(path) + a;}

生成文档

JApiDocs用法基本就这样了，非常简单，美中不足的是不支持像swagger那样在线调用，大家去作者GitHub催催他添加这个功能把。

SpringBoot自动生成接口文档相关推荐

SpringBoot 如何生成接口文档，老鸟们都这么玩的！
为什么要用Swagger ? " 作为一名程序员,我们最讨厌两件事:1. 别人不写注释.2. 自己写注释. 而作为一名接口开发者,我们同样讨厌两件事:1. 别人不写接口文档,文档不及时更新. ...
自动生成接口文档之JApiDocs教程
JApiDocs教程前言作为一名优秀的程序员来说,由于涉及到要与前端进行对接,所以避免不了的就是写接口文档.写完接口文档,一旦代码返回结果,参数等出现变动,接口文档还得随之改动,十分麻烦,违背了我 ...
SpringBoot 自动生成API文档
SpringBoot 自动生成API文档在做项目的时候,如果项目是前后分离的,后端一定要和前端或者是移动端对接接口,那么问题来了,接口是不是要自己写给他们看,一般的会采用Excel或者Word来写, ...
Django框架深入了解_05 (Django中的缓存、Django解决跨域流程(非简单请求，简单请求)、自动生成接口文档)(二)
二.跨域: 回到顶部跨域知识介绍: 点我以前博客跨域解决方法:CORS:跨域资源共享 CORS请求分类(简单请求和非简单请求) 简单请求(simple request):只需要在头信息之中增加一个 ...
Django框架深入了解_05 (Django中的缓存、Django解决跨域流程(非简单请求，简单请求)、自动生成接口文档)(一)
阅读目录一.Django中的缓存: 前戏: Django中的几种缓存方式: Django中的缓存应用: 二.跨域: 跨域知识介绍: CORS请求分类(简单请求和非简单请求) 示例: 三.自动生成接口 ...
Spring Boot（九）Swagger2自动生成接口文档和Mock模拟数据
一.简介在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...
idea swagger生成接口文档_Spring Boot（九）Swagger2自动生成接口文档和Mock模拟数据...
一.简介在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...
java自动生成接口文档
java自动生成接口文档 maven依赖工具类展示效果首页接口页在平时的开发过程中必定要写接口文档作为程序员最烦的2件事 1.别人让你写接口文档 2.接手别人的项目没有接口文档由此可见 ...
DRF 自动生成接口文档
Python微信订餐小程序课程视频 https://edu.csdn.net/course/detail/36074 Python实战量化交易理财系统 https://edu.csdn.net/cou ...

SpringBoot自动生成接口文档

该工具的用法

定义一个类

定义一个接口

往接口上面添加注释

get请求

侧边栏

SpringBoot自动生成接口文档相关推荐

最新文章

热门文章