Swagger中@ApiIgnore注解的使用詳解
更新時間：2021年10月20日 17:08:53 作者：周公解碼
這篇文章主要介紹了Swagger中@ApiIgnore注解的使用，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
Swagger @ApiIgnore注解的使用
@ApiIgnore 可以用在類、方法上，方法參數(shù)中，用來屏蔽某些接口或參數(shù)，使其不在頁面上顯示。
1、作用在類上時，整個類都會被忽略
@ApiIgnore
@Api(tags = {"Xxx控制類"})
@RestController
@RequestMapping("/xxx")
public class XxxController {
......
}
隱藏某個類還可以用@Api注解自帶的hidden屬性：
@Api(value = "xxx", tags = "xxx",hidden = true)
當hidden為true時，該類隱藏。
2、當作用在方法上時，方法將被忽略
@ApiIgnore
@ApiOperation(value = "xxx", httpMethod = "POST", notes = "xxx")
@ApiImplicitParams({
@ApiImplicitParam(name = "xxx", value = "xxx", paramType = "query", dataType = "String", required = true)
})
@PostMapping("/xxx")
public Result importCarryEquExcel(String xxx) {
......
}
隱藏某個方法還可以用@APIOperation注解自帶的hidden屬性：
@ApiOperation(value = "xxx", httpMethod = "GET", notes = "xxx",hidden = true)
當hidden為true時，該方法隱藏。
3、作用在參數(shù)上時，單個具體的參數(shù)會被忽略
public String abc(@ApiIgnore String a, String b, String c){
return "a" + "b" + "c";
}
補充：
4、 在實體類中忽略不需要字段的方式
（1）用@ApiModelProperty注解自帶的hidden屬性:
@ApiModelProperty(value = "xxxid", required = true,hidden = true)
private Long id;
（2）使用@JsonIgnore注解：
@ApiModelProperty(value = "xxxid", required = true)
@JsonIgnore
private Long id;
包名：
import com.fasterxml.jackson.annotation.JsonIgnore;
swagger 注解的使用解析
Swagger簡介
由于架構革新，進入了前后端分離，服務端只需提供RESTful API的時代。
而構建RESTful API會考慮到多終端的問題，這樣就需要面對多個開發(fā)人員甚至多個開發(fā)團隊。為了減少與其他團隊對接的溝通成本，我們通常會寫好對應的API接口文檔。
從最早開始的word文檔，到后續(xù)的showdoc，都能減少很多溝通成本，但隨之帶來的問題也比較麻煩。在開發(fā)期間接口會因業(yè)務的變更頻繁而變動，如果需要實時更新接口文檔，這是一個費時費力的工作。
為了解決上面的問題，Swagger應運而生。他可以輕松的整合進框架，并通過一系列注解生成強大的API文檔。他既可以減輕編寫文檔的工作量，也可以保證文檔的實時更新，將維護文檔與修改代碼融為一體，是目前較好的解決方案。
常用注解
@Api()用于類；- 表示標識這個類是swagger的資源
@ApiOperation()用于方法；- 表示一個http請求的操作
@ApiParam()用于方法，參數(shù)，字段說明；- 表示對參數(shù)的添加元數(shù)據(jù)（說明或是否必填等）
@ApiModel()用于類- 表示對類進行說明，用于參數(shù)用實體類接收
@ApiModelProperty()用于方法，字段- 表示對model屬性的說明或者數(shù)據(jù)操作更改
@ApiIgnore()用于類，方法，方法參數(shù)- 表示這個方法或者類被忽略
@ApiImplicitParam()用于方法- 表示單獨的請求參數(shù)
@ApiImplicitParams()用于方法，包含多個 @ApiImplicitParam
代碼示例
1、@Api
@Api(value = "用戶博客", tags = "博客接口")
public class NoticeController {
}
2、@ApiOperation
@GetMapping("/detail")
@ApiOperation(value = "獲取用戶詳細信息", notes = "傳入notice" , position = 2)
public R<Notice> detail(Integer id) {
Notice detail = noticeService.getOne(id);
return R.data(detail );
}
3、@ApiResponses
@ApiResponses(value = {@ApiResponse(code = 500, msg= "INTERNAL_SERVER_ERROR", response = R.class)})
@GetMapping("/detail")
@ApiOperation(value = "獲取用戶詳細信息", notes = "傳入notice" , position = 2)
@ApiResponses(value = {@ApiResponse(code = 500, msg= "INTERNAL_SERVER_ERROR", response = R.class)})
public R<Notice> detail(Integer id) {
Notice detail = noticeService.getOne(id);
return R.data(detail );
}
4、@ApiImplicitParams
以分頁代碼進行展示
IPage<Notice> pages = noticeService.page(Condition.getPage(query), Condition.getQueryWrapper(notice, Notice.class));
@GetMapping("/list")
@ApiImplicitParams({
@ApiImplicitParam(name = "category", value = "公告類型", paramType = "query", dataType = "integer"),
@ApiImplicitParam(name = "title", value = "公告標題", paramType = "query", dataType = "string")
})
@ApiOperation(value = "分頁", notes = "傳入notice", position = 3)
public R<IPage<Notice>> list(@ApiIgnore @RequestParam Map<String, Object> notice, Query query) {
IPage<Notice> pages = noticeService.page(Condition.getPage(query), Condition.getQueryWrapper(notice, Notice.class));
return R.data(pages );
}
5、@ApiParam
@PostMapping("/remove")
@ApiOperation(value = "邏輯刪除", notes = "傳入notice", position = 7)
public R remove(@ApiParam(value = "主鍵集合") @RequestParam String ids) {
boolean temp = noticeService.deleteLogic(Func.toIntList(ids));
return R.status(temp);
}
6、@ApiModel 與 @ApiModelProperty
@Data
@ApiModel(value = "BladeUser ", description = "用戶對象")
public class BladeUser implements Serializable {
private static final long serialVersionUID = 1L;
@ApiModelProperty(value = "主鍵", hidden = true)
private Integer userId;
@ApiModelProperty(value = "昵稱")
private String userName;
@ApiModelProperty(value = "賬號")
private String account;
@ApiModelProperty(value = "角色id")
private String roleId;
@ApiModelProperty(value = "角色名")
private String roleName;
}
7、@ApiIgnore()
@ApiIgnore()
@GetMapping("/detail")
public R<Notice> detail(Integer id) {
Notice detail = noticeService.getOne(id);
return R.data(detail );
}
以上為個人經驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關文章
這篇文章主要介紹了IDEA 自定義方法注解模板的實現(xiàn)方法，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2019-09-09
在日常開發(fā)時,我們常常需要 在SpringBoot應用啟動時執(zhí)行某一段邏輯,如獲取一些當前環(huán)境的配置或變量、向數(shù)據(jù)庫寫入一些初始數(shù)據(jù)或者連接某些第三方系統(tǒng),確認對方可以工作,那么在實現(xiàn)初始化邏輯代碼時就需要小心了,所以本文介紹了SpringBoot初始化加載配置的方式2024-12-12
詳解 Java Maximum redirects (100) exceeded
這篇文章主要介紹了詳解 Java Maximum redirects (100) exceeded的相關資料,需要的朋友可以參考下2017-05-05
mybatis中使用sqlMap進行sql查詢時,經常需要動態(tài)傳遞參數(shù),在動態(tài)SQL解析階段, #{ } 和 ${ } 會有不同的表現(xiàn),這篇文章主要給大家介紹了關于mybatis中${}和#{}取值區(qū)別的相關資料,需要的朋友可以參考下2021-09-09
這篇文章主要介紹了SpringMVC請求流程源碼分析,包括springmvc使用，SpringMVC啟動過程及SpringMVC請求過程，本文通過實例代碼給大家介紹的非常詳細，需要的朋友可以參考下2022-07-07
Java?8函數(shù)式接口之Consumer用法示例詳解
這篇文章主要為大家介紹了Java?8函數(shù)式接口之Consumer用法示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2023-07-07
SpringCloud_Eureka服務注冊與發(fā)現(xiàn)基礎及構建步驟
Eureka服務注冊中心，主要用于提供服務注冊功能，當微服務啟動時，會將自己的服務注冊到Eureka Server，這篇文章主要介紹了SpringCloud中Eureka的配置及詳細使用,需要的朋友可以參考下2023-01-01
淺談Java并發(fā) J.U.C之AQS：CLH同步隊列
AQS內部維護著一個FIFO隊列，該隊列就是CLH同步隊列。下面小編來簡單介紹下這個隊列2019-05-05
為什么阿里要慎重使用ArrayList中的subList方法
這篇文章主要介紹了為什么要慎重使用ArrayList中的subList方法,subList是List接口中定義的一個方法，該方法主要用于返回一個集合中的一段、可以理解為截取一個集合中的部分元素，他的返回值也是一個List。,需要的朋友可以參考下2019-06-06
今天給大家?guī)淼奈恼率荍ava并發(fā)容器的相關知識,文中有非常詳細的介紹,對正在學習Java并發(fā)容器的小伙伴們很有幫助,需要的朋友可以參考下2021-06-06