Swagger2 構建 RESTful APIs的使用

@Api 的使用

Api 做用在 Controller 類上，作爲 Swagger 文檔資源，該註解將一個 Controller（Class）標註爲一個 Swagger 資源（API）。Swagger-Core 默認只會掃描解析具備 @Api 註解的類，而會自動忽略其餘類別資源。

屬性配置如表所示：

@ApiOperation 的使用

ApiOperation 定義在方法上，描述方法名、方法解釋、返回信息、標記等信息。

@ApiImplicitParams 和 @ApiImplicitParam 的使用

@ApiImplicitParams 用於描述方法的返回信息，和 @ApiImplicitParam 註解配合使用；@ApiImplicitParam 用來描述具體某一個參數的信息，包括參數的名稱、類型、限制等信息。

@ApiParam

用在請求方法中，描述參數信息
name：參數名稱，參數名稱能夠覆蓋方法參數名稱，路徑參數必須與方法參數一致
value：參數的簡要說明。
defaultValue：參數默認值
required 屬性是否必填，默認爲false [路徑參數必須填]

@ApiResponses 和 @ApiResponse 的使用

@ApiResponses 主要封裝方法的返回信息和 @ApiResponse 配置起來使用，@ApiResponse 定義返回的具體信息包括返回碼、返回信息等。

@ApiModel 和 @ApiModelProperty 的使用

在實際的項目中咱們經常會封裝一個對象做爲返回值，@ApiModel 就是負責描述對象的信息，@ApiModelProperty 負責描述對象中屬性的相關內容。

參考

參考：使用 Swagger 2 構建 RESTful APIs