swagger註釋API詳細說明

版權聲明：本文供交流學習，可以幫助到你是我最大的榮幸！ https://blog.csdn.net/u014231523/article/details/76522486

說明：
1.這裏使用的版本：springfox-swagger2（2.4）springfox-swagger-ui （2.4）
2.這裏是說明經常使用註解的含義和基本用法（也就是說已經對swagger進行集成完成）
沒有集成的請參見
SpringBoot集成springfox-swagger2構建restful API
SpringMVC集成springfox-swagger2構建restful API
官網WIKI
經常使用註解：
- @Api()用於類；
表示標識這個類是swagger的資源
- @ApiOperation()用於方法；
表示一個http請求的操做
- @ApiParam()用於方法，參數，字段說明；
表示對參數的添加元數據（說明或是否必填等）
- @ApiModel()用於類
表示對類進行說明，用於參數用實體類接收
- @ApiModelProperty()用於方法，字段
表示對model屬性的說明或者數據操做更改
- @ApiIgnore()用於類，方法，方法參數
表示這個方法或者類被忽略
- @ApiImplicitParam() 用於方法
表示單獨的請求參數
- @ApiImplicitParams() 用於方法，包含多個 @ApiImplicitParam

具體使用舉例說明：
@Api()
用於類；表示標識這個類是swagger的資源
tags–表示說明
value–也是說明，能夠使用tags替代
可是tags若是有多個值，會生成多個list

@Api(value="用戶controller",tags={"用戶操做接口"})
@RestController
public class UserController {

}

效果圖：

@ApiOperation() 用於方法；表示一個http請求的操做
value用於方法描述
notes用於提示內容
tags能夠從新分組（視狀況而用）
@ApiParam() 用於方法，參數，字段說明；表示對參數的添加元數據（說明或是否必填等）
name–參數名
value–參數說明
required–是否必填

@Api(value="用戶controller",tags={"用戶操做接口"})
@RestController
public class UserController {
     @ApiOperation(value="獲取用戶信息",tags={"獲取用戶信息copy"},notes="注意問題點")
     @GetMapping("/getUserInfo")
     public User getUserInfo(@ApiParam(name="id",value="用戶id",required=true) Long id,@ApiParam(name="username",value="用戶名") String username) {
     // userService可忽略，是業務邏輯
      User user = userService.getUserInfo();

      return user;
  }
}

效果圖：

@ApiModel()用於類 ；表示對類進行說明，用於參數用實體類接收
value–表示對象名
description–描述
均可省略
@ApiModelProperty()用於方法，字段； 表示對model屬性的說明或者數據操做更改
value–字段說明
name–重寫屬性名字
dataType–重寫屬性類型
required–是否必填
example–舉例說明
hidden–隱藏

@ApiModel(value="user對象",description="用戶對象user")
public class User implements Serializable{
    private static final long serialVersionUID = 1L;
     @ApiModelProperty(value="用戶名",name="username",example="xingguo")
     private String username;
     @ApiModelProperty(value="狀態",name="state",required=true)
      private Integer state;
      private String password;
      private String nickName;
      private Integer isDeleted;

      @ApiModelProperty(value="id數組",hidden=true)
      private String[] ids;
      private List<String> idList;
     //省略get/set
}

@ApiOperation("更改用戶信息")
  @PostMapping("/updateUserInfo")
  public int updateUserInfo(@RequestBody @ApiParam(name="用戶對象",value="傳入json格式",required=true) User user){

     int num = userService.updateUserInfo(user);
     return num;
  }

效果圖：

@ApiIgnore()用於類或者方法上，能夠不被swagger顯示在頁面上
比較簡單, 這裏不作舉例

@ApiImplicitParam() 用於方法
表示單獨的請求參數
@ApiImplicitParams() 用於方法，包含多個 @ApiImplicitParam
name–參數ming
value–參數說明
dataType–數據類型
paramType–參數類型
example–舉例說明

@ApiOperation("查詢測試") @GetMapping("select") //@ApiImplicitParam(name="name",value="用戶名",dataType="String", paramType = "query") @ApiImplicitParams({ @ApiImplicitParam(name="name",value="用戶名",dataType="string", paramType = "query",example="xingguo"), @ApiImplicitParam(name="id",value="用戶id",dataType="long", paramType = "query")}) public void select(){

  }

效果圖：