1、@Api

含義：

標識一個模組的描述，一般用於restful介面的類註解

常用屬性：

1）value：用於介面模組的標題描述，似乎1.5版本後不可用

2）tags：用於介面模組的標題描述

3）description：描述介面類的詳細資訊，副標題，雖然起作用，但是後面可能會被廢棄

4）produces：介面能夠返回的資源型別，以逗號分隔，如："application/json, application/xml"

5）consumes：介面能夠接受的資源型別，以逗號分隔，如："application/json, application/xml"

6）protocols：介面支援的傳輸協議，以逗號分隔，可能的值:http, https, ws, wss

7）hidden：在文件中是否隱藏，預設false；其實使用註解@ApiIgnore更為方便。

示例

@Api(tags="使用者模組操作介面", consumes="application/json", produces="application/json", protocols="http, https, ws, wss", description="用於使用者介面新增、修改、刪除以及查詢！")
@RestController
@RequestMapping(value="users")
public class UserController {

顯示

2、ApiOperation

含義：

屬性：

1）value：api操作的概要

2）notes：api操作的贅述

3）tags：1.5.2版本開始的api文件版本控制的標籤列表

4）response：操作的相應型別，預設Void.class

5）responseContainer：描述相應的容器，有效值："List", "Set" 或"Map"；其他值被忽略

6）responseReference：相應引用，相應可能是本地或遠端引用

7）httpMethod："GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS" and "PATCH"

示例：

@ApiOperation(value="查詢使用者所有列表", tags="v1.0", httpMethod="GET", response=PageInfoVo.class)
    @RequestMapping(method=RequestMethod.GET)
    public club.isource.platform.vo.PageInfoVo<User> selectAll() {
        return userService.selectAll();
    }
 

結果

3、@ApiModel

含義：

定義介面中使用的模型資料

屬性：

1）value：模型的名字

2）description：詳細的描述

3）parent：是否存在父類，預設Void.class

4）subTypes：是否有繼承該型別的子類

5）reference：引用的相關類

示例：

@ApiModel(value="使用者實體類", description="作為系統中的使用者實體，是系統的核心操作人員")
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonInclude(Include.NON_EMPTY)
public class User {

結果：

4、@ApiModelProperty

含義：

描述資料模型的屬性註解

屬性：

1）value：模型屬性的含義

2）allowableValues：允許的值，例如：range[1, 5]

3）dataType：資料型別

4）required：是否必須有值，預設false

5）example：屬性值的舉例

6）readOnly：只讀屬性

7）reference：該屬性是否引用其他類

8）allowEmptyValue：是否允許空值，預設false

示例：

@ApiModelProperty(value="使用者唯一標識")
private Integer userid;

結果：