swagger是當前最好用的Restful API文檔生成的開源項目,通過swagger-spring項目實現了springMVC框架的無縫集成功能,方便生成restful風格的接口文檔,
同時,swagger-ui還可以測試spring restful風格的接口功能
作用范圍 API 使用位置
對象屬性 @ApiModelProperty 用在參數對象的字段上
協議集描述 @Api 用在Conntroller類上
協議描述 @ApiOperation 用在controller方法上
Response集 @ApiResponses 用在controller方法上
Response @ApiResponse 用在@ApiResponses里面
非對象參數集 @ApilmplicitParams 用在controller方法上
| 非對象參數描述 | @ApiImplicitParam | 用在@ApiImplicitParams的方法里邊 |
| 描述返回對象的意義 | @ApiModel | 用在返回對象類上 |
@ApiModelProperty的用法
value–字段說明
name–重寫屬性名字
dataType–重寫屬性類型
required–是否必填
example–舉例說明
hidden–隱藏
// 我這個用在實體類的get()方法上了
/**
* 獲取城市編號
* @return 城市編號
*/
@ApiModelProperty(value="城市編號",example="058",required=true)
public String getCode() {
return code;
}/**
* 設置城市編號
* @param code 城市編號
*/
public void setCode(String code) {
this.code = code;
}/**
* 獲取城市名稱
* @return 城市名稱
*/
@ApiModelProperty(value="城市名稱",example="guangZhou",required=true)
public String getName() {
return name;
}
@Api
value - 字段說明
description - 注釋說明這個類
@ApiOperation
value - 字段說明
notes - 注釋說明
httpMethod - 說明這個方法被請求的方式
response - 方法的返回值的類型
@ApiResponse
code - 響應的HTTP狀態碼
message - 響應的信息內容
本文轉載自:https://www.cnblogs.com/xinglongbing521/p/10258818.html