spring-boot-route（六）整合JApiDocs生成介面文件
阿新 • • 發佈：2020-10-06
上一篇文章中介紹了使用Swagger生成介面文件，非常方便，功能也十分強大。如果非要說Swaager有什麼缺點，想必就是註解寫起來比較麻煩。如果我說有一款不用寫註解，就可以生成文件的工具，你心動了嗎？他就是我們今天的主角——JApiDocs。
下面我們一起來看看如何使用！
## 一、新增依賴
```xml
```
## 二、配置生成引數
我們新建一個專案，然後隨便寫一個main方法，增加生成文件的配置，然後執行main方法。
```java
DocsConfig config = new DocsConfig();
config.setProjectPath("F:\\Java旅途\\japi-docs"); // 專案根目錄
config.setProjectName("japi-docs"); // 專案名稱
config.setApiVersion("V1.0"); // 宣告該API的版本
config.setDocsPath("F:\\test"); // 生成API 文件所在目錄
config.setAutoGenerate(Boolean.TRUE); // 配置自動生成
Docs.buildHtmlDocs(config); // 執行生成文件
```
## 三、編碼規範
由於JApiDocs是通過解析Java原始碼來實現的，因此如果要想實現想要的文件，還是需要遵循一定的規範。
### 3.1 類註釋、方法註釋和屬性註釋
如果我們想生成類的註釋，我們可以直接在類上加註釋，也可以通過加@description來生成。
```java
/**
* 使用者介面類
*/
@RequestMapping("/api/user")
@RestController
public class UserController {}
/**
* @author Java旅途
* @Description 使用者介面類
* @Date 2020-06-15 21:46
*/
@RequestMapping("/api/user")
@RestController
public class UserController {}
```
如果我們想生成方法的註釋，只能直接加註釋，不能通過加@description來生成。
```java
/**
* 查詢使用者
* @param age 年齡
* @