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"。

?出現一個對話框，對話框內就算文檔注釋

總結

以上是生活随笔為你收集整理的IDEA插件系列（64）：Document Assistant插件——SpringMVC文档助手的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。