1,引入maven
<dependency> <groupId>com.github.terran4j</groupId> <artifactId>terran4j-commons-api2doc</artifactId> <version>1.0.2</version> </dependency>
2,
@Api2Doc 注解詳述
Api2Doc 一共有 3 個注解：@Api2Doc、@ApiComment 及 @ApiError 。
@Api2Doc 用於對文檔的生成進行控制。
@Api2Doc 修飾在類上，表示這個類會參與到文檔生成過程中，Api2Doc 服務
會掃描 Spring 容器中所有的 Controller 類，只有類上有 @Api2Doc 的類，
才會被生成文檔，一個類對應於文檔頁面左側的一級菜單項，@Api2Doc 的
name 屬性則表示這個菜單項的名稱。
@Api2Doc 也可以修飾在方法，不過在方法上的 @Api2Doc 通常是可以省略，
Api2Doc 服務會掃描這個類的所有帶有 @RequestMapping 的方法，
每個這樣的方法對應文檔頁面的左側的二級菜單項， 菜單項的名稱取
@RequestMapping 的 name 屬性，當然您仍然可以在方法上用 @Api2Doc
的 name 屬性進行重定義。
@ApiComment 注解詳述
@ApiComment 用於對 API 進行說明，它可以修飾在很多地方：
- 修飾在類上，表示對這組 API 接口進行說明；
- 修飾在方法上，表示對這個 API 接口進行說明；
- 修飾在參數上，表示對這個 API 接口的請求參數進行說明；
- 修飾在返回類型的屬性上，表示對這個 API 接口的返回字段進行說明；
- 修飾在枚舉項上，表示對枚舉項進行說明；
如果相同名稱、相同意義的屬性或參數字段，其說明已經在別的地方定義過了，
可以用 @ApiComment 的 seeClass 屬性表示采用指定類的同名字段上的說明信息
@ApiComment(seeClass = User.class)
@ApiError 注解詳述
@ApiError 用於定義錯誤碼，有的 API 方法在執行業務邏輯時會產生錯誤，
出錯后會在返回報文包含錯誤碼，以方便客戶端根據錯誤碼作進一步的處理，
因此也需要在 API 文檔上體現錯誤碼的說明。
@ApiError 的 value 屬性表示錯誤碼，comment 表示錯誤碼的說明。
可以用 @Api2Doc 中的 order 屬性給菜單項排序，order 的值越小，
該菜單項就越排在前面.