1.插件介绍
Document Assistant插件。
文档助手是基于SpringMVC代码动态生成markdown文档的插件,通过文档助手简单的通过代码注释、SpringMVC的基础注解实现HTTP API的文档生成。
- 1、通过动态分析项目应用配置文件以及注解配置生成其URI请求;
- 2、通过SpringMVC的接口入口方法参数,分析入参的内容以及相关的注释生成入参表格以及请求JSON;
- 3、通过SpringMVC的接口入口方法返回值,分析地址接口的出参内容以及注释生成出参表格以及回复的JSON;
注意:
- 1、控制器必须在类标识了@RestController;
- 2、需要生成的接口方法,需要选择方法名,然后调用生成菜单(就是平时调用生成getter setter的菜单)点击生成文档视频;
2.安装方式
第一种方式,是在IDEA上搜索插件进行安装,会适配当前IDEA的版本。
第二种安装方式是使用离线插件进行安装。
插件下载地址:https://plugins.jetbrains.com/plugin/12764-document-assistant
3.使用方法
在SpringMVC中创建如下一个控制器类
@RestController
public class HelloController {
@GetMapping("/hello")
public String hello() {
return "Hello SpringBoot!";
}
}
注意,控制器类必须使用@RestController注解。
然后选中方法名,这里选中"hello",然后按快捷键Alt+Insert,出现如下面板,选择"REST API Document generate"。
出现一个对话框,对话框内就算文档注释