Swagger注解詳情

@Api() 
用于類;表示標(biāo)識這個(gè)類是swagger的資源 
tags–表示說明 
value–也是說明,可以使用tags替代 
但是tags如果有多個(gè)值,會生成多個(gè)list

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

@ApiOperation() 用于方法;表示一個(gè)http請求的操作 
value用于方法描述 
notes用于提示內(nèi)容 
tags可以重新分組(視情況而用) 
@ApiParam() 用于方法,參數(shù),字段說明;表示對參數(shù)的添加元數(shù)據(jù)(說明或是否必填等) 
name–參數(shù)名 
value–參數(shù)說明 
required–是否必填

@Api(value="用戶controller",tags={"用戶操作接口"})
@RestController
public class UserController {
     @ApiOperation(value="獲取用戶信息",tags={"獲取用戶信息copy"},notes="注意問題點(diǎn)")
     @GetMapping("/getUserInfo")
     public User getUserInfo(@ApiParam(name="id",value="用戶id",required=true) Long id,@ApiParam(name="username",value="用戶名") String username) {
     // userService可忽略,是業(yè)務(wù)邏輯
      User user = userService.getUserInfo();
      return user;
  }
}
@ApiModel()用于類 ;表示對類進(jìn)行說明,用于參數(shù)用實(shí)體類接收 
value–表示對象名 
description–描述 
都可省略 
@ApiModelProperty()用于方法,字段; 表示對model屬性的說明或者數(shù)據(jù)操作更改 
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="狀態(tài)",name="state",required=true)
      private Integer state;
      private String password;
      private String nickName;
      private Integer isDeleted;
 
      @ApiModelProperty(value="id數(shù)組",hidden=true)
      private String[] ids;
      private List<String> idList;
     //省略get/set
}
@ApiIgnore()用于類或者方法上,可以不被swagger顯示在頁面上 
比較簡單, 這里不做舉例
@ApiImplicitParam() 用于方法 
表示單獨(dú)的請求參數(shù) 
@ApiImplicitParams() 用于方法,包含多個(gè) @ApiImplicitParam 
name–參數(shù)ming 
value–參數(shù)說明 
dataType–數(shù)據(jù)類型 
paramType–參數(shù)類型 
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(){
}
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容