最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

Java中Swagger框架的使用詳解

 更新時(shí)間:2023年08月30日 11:06:02   作者:余生海  
這篇文章主要介紹了Java框架Swagger的使用詳解,在開發(fā)期間接口會(huì)因業(yè)務(wù)的變更頻繁而變動(dòng),如果需要實(shí)時(shí)更新接口文檔,這是一個(gè)費(fèi)時(shí)費(fèi)力的工作,Swagger應(yīng)運(yùn)而生,他可以輕松的整合進(jìn)框架并通過(guò)一系列注解生成強(qiáng)大的API文檔,需要的朋友可以參考下

簡(jiǎn)介

  • 由于架構(gòu)革新,進(jìn)入了前后端分離,服務(wù)端只需提供RESTful API的時(shí)代。
  • 而構(gòu)建RESTful API會(huì)考慮到多終端的問(wèn)題,這樣就需要面對(duì)多個(gè)開發(fā)人員甚至多個(gè)開發(fā)團(tuán)隊(duì)。
  • 為了減少與其他團(tuán)隊(duì)對(duì)接的溝通成本,我們通常會(huì)寫好對(duì)應(yīng)的API接口文檔。
  • 從最早開始的word文檔,到后續(xù)的showdoc,都能減少很多溝通成本,但隨之帶來(lái)的問(wèn)題也比較麻煩。在開發(fā)期間接口會(huì)因業(yè)務(wù)的變更頻繁而變動(dòng),如果需要實(shí)時(shí)更新接口文檔,這是一個(gè)費(fèi)時(shí)費(fèi)力的工作。
  • 為了解決上面的問(wèn)題,Swagger應(yīng)運(yùn)而生。他可以輕松的整合進(jìn)框架,并通過(guò)一系列注解生成強(qiáng)大的API文檔。他既可以減輕編寫文檔的工作量,也可以保證文檔的實(shí)時(shí)更新,將維護(hù)文檔與修改代碼融為一體,是目前較好的解決方案。

常用注解

  • @Api()用于類;
  • 表示標(biāo)識(shí)這個(gè)類是swagger的資源
  • @ApiOperation()用于方法;
  • 表示一個(gè)http請(qǐng)求的操作
  • @ApiParam()用于方法,參數(shù),字段說(shuō)明;
  • 表示對(duì)參數(shù)的添加元數(shù)據(jù)(說(shuō)明或是否必填等)
  • @ApiModel()用于類
  • 表示對(duì)類進(jìn)行說(shuō)明,用于參數(shù)用實(shí)體類接收
  • @ApiModelProperty()用于方法,字段
  • 表示對(duì)model屬性的說(shuō)明或者數(shù)據(jù)操作更改
  • @ApiIgnore()用于類,方法,方法參數(shù)
  • 表示這個(gè)方法或者類被忽略
  • @ApiImplicitParam() 用于方法
  • 表示單獨(dú)的請(qǐng)求參數(shù)
  • @ApiImplicitParams() 用于方法,包含多個(gè) @ApiImplicitParam

代碼示例

  • @Api
@Api(value = "用戶博客", tags = "博客接口")
public class NoticeController {
}
  • @ApiOperation
@GetMapping("/detail")
@ApiOperation(value = "獲取用戶詳細(xì)信息", notes = "傳入notice")
public R<Notice> detail(Integer id) {
   Notice detail = noticeService.getOne(id);
   return R.data(detail );
}
  • @ApiResponses
@GetMapping("/detail")
@ApiOperation(value = "獲取用戶詳細(xì)信息", notes = "傳入notice")
@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 );
}
  • @ApiImplicitParams
@GetMapping("/list")
@ApiImplicitParams({
   @ApiImplicitParam(name = "category", value = "公告類型", paramType = "query", dataType = "integer"),
   @ApiImplicitParam(name = "title", value = "公告標(biāo)題", paramType = "query", dataType = "string")
})
@ApiOperation(value = "分頁(yè)", notes = "傳入notice")
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 );
}
  • @ApiParam
@PostMapping("/remove")
@ApiOperation(value = "邏輯刪除", notes = "傳入notice")
public R remove(@ApiParam(value = "主鍵集合") @RequestParam String ids) {
   boolean temp = noticeService.deleteLogic(Func.toIntList(ids));
   return R.status(temp);
}
  • @ApiModel 與 @ApiModelProperty
@Data
@ApiModel(value = "BladeUser ", description = "用戶對(duì)象")
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 = "賬號(hào)")
   private String account;
   @ApiModelProperty(value = "角色id")
   private String roleId;
   @ApiModelProperty(value = "角色名")
   private String roleName;
}
  • @ApiIgnore()
@ApiIgnore()
@GetMapping("/detail")
public R<Notice> detail(Integer id) {
   Notice detail = noticeService.getOne(id);
   return R.data(detail );
}

到此這篇關(guān)于Java中間件Swagger的使用詳解的文章就介紹到這了,更多相關(guān)Swagger的使用內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!

相關(guān)文章

  • Java全版本特性與用法示例(含總覽?+?分版本要點(diǎn))

    Java全版本特性與用法示例(含總覽?+?分版本要點(diǎn))

    Java自JDK8開啟現(xiàn)代化演進(jìn)以來(lái),始終遵循半年特性版本+兩年LTS(長(zhǎng)期支持)版本的發(fā)布節(jié)奏,持續(xù)在語(yǔ)言表達(dá)力、并發(fā)性能、開發(fā)體驗(yàn)、安全能力四大維度突破,這篇文章主要介紹了Java全版本特性與用法(含總覽+分版本要點(diǎn))的相關(guān)資料,需要的朋友可以參考下
    2026-05-05
  • 用Java設(shè)計(jì)模式中的觀察者模式開發(fā)微信公眾號(hào)的例子

    用Java設(shè)計(jì)模式中的觀察者模式開發(fā)微信公眾號(hào)的例子

    這篇文章主要介紹了用Java設(shè)計(jì)模式中的觀察者模式開發(fā)微信公眾號(hào)的例子,這里Java的微信SDK等部分便不再詳述,只注重關(guān)鍵部分和開發(fā)過(guò)程中觀察者模式優(yōu)點(diǎn)的體現(xiàn),需要的朋友可以參考下
    2016-02-02
  • JDK21對(duì)虛擬線程的幾種用法實(shí)踐指南

    JDK21對(duì)虛擬線程的幾種用法實(shí)踐指南

    虛擬線程是Java中的一種輕量級(jí)線程,由JVM管理,特別適合于I/O密集型任務(wù),這篇文章主要介紹了JDK21對(duì)虛擬線程的幾種用法,文中通過(guò)代碼介紹的非常詳細(xì),需要的朋友可以參考下
    2025-09-09
  • Java IO三大模型(BIO/NIO/AIO)的使用總結(jié)

    Java IO三大模型(BIO/NIO/AIO)的使用總結(jié)

    相信很多Java開發(fā)剛接觸IO模型時(shí),都會(huì)被「BIO、NIO、AIO」「同步、異步、阻塞、非阻塞」這些概念繞暈,下面就來(lái)詳細(xì)的介紹一下 IO三大模型的使用,感興趣的可以了解一下
    2026-02-02
  • Spring處理@Async導(dǎo)致的循環(huán)依賴失敗問(wèn)題的方案詳解

    Spring處理@Async導(dǎo)致的循環(huán)依賴失敗問(wèn)題的方案詳解

    這篇文章主要為大家詳細(xì)介紹了SpringBoot中的@Async導(dǎo)致循環(huán)依賴失敗的原因及其解決方案,文中的示例代碼講解詳細(xì),感興趣的可以學(xué)習(xí)一下
    2022-07-07
  • ssm?mybatis如何配置多個(gè)mapper目錄

    ssm?mybatis如何配置多個(gè)mapper目錄

    這篇文章主要介紹了ssm?mybatis如何配置多個(gè)mapper目錄,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教。
    2022-01-01
  • springboot+vue實(shí)現(xiàn)Token自動(dòng)續(xù)期(雙Token方案)

    springboot+vue實(shí)現(xiàn)Token自動(dòng)續(xù)期(雙Token方案)

    雙Token方案通過(guò)訪問(wèn)令牌和刷新令牌提高用戶登錄安全性和體驗(yàn),訪問(wèn)令牌有效期短,包含用戶信息,用于請(qǐng)求校驗(yàn),本文就來(lái)介紹一下springboot+vue實(shí)現(xiàn)Token自動(dòng)續(xù)期(雙Token方案),感興趣的可以了解一下
    2024-10-10
  • java 中@Deprecated 注解的實(shí)例詳解

    java 中@Deprecated 注解的實(shí)例詳解

    這篇文章主要介紹了java 中@Deprecated 注解的實(shí)例詳解的相關(guān)資料,這里對(duì)@Deprecated注解進(jìn)行了詳細(xì)介紹,希望能幫助到大家,需要的朋友可以參考下
    2017-08-08
  • Java聊天室之實(shí)現(xiàn)使用Socket傳遞音頻

    Java聊天室之實(shí)現(xiàn)使用Socket傳遞音頻

    這篇文章主要為大家詳細(xì)介紹了Java簡(jiǎn)易聊天室之使用Socket實(shí)現(xiàn)傳遞音頻功能,文中的示例代碼講解詳細(xì),具有一定的借鑒價(jià)值,需要的可以了解一下
    2022-10-10
  • 深入淺出RocketMQ的事務(wù)消息

    深入淺出RocketMQ的事務(wù)消息

    RocketMQ事務(wù)消息(Transactional?Message)是指應(yīng)用本地事務(wù)和發(fā)送消息操作可以被定義到全局事務(wù)中,要么同時(shí)成功,要么同時(shí)失敗。本文主要介紹了RocketMQ事務(wù)消息的相關(guān)知識(shí),需要的可以參考一下
    2023-04-04

最新評(píng)論

五寨县| 深圳市| 年辖:市辖区| 新疆| 双流县| 威海市| 新河县| 新郑市| 宜兴市| 玛曲县| 诸城市| 壶关县| 东乌珠穆沁旗| 金坛市| 阳春市| 罗甸县| 崇义县| 怀化市| 府谷县| 息烽县| 泾源县| 榆中县| 东乡| 淳化县| 彰化县| 西贡区| 城固县| 南阳市| 肥东县| 二连浩特市| 宜都市| 阜宁县| 红河县| 柯坪县| 三台县| 阜平县| 安远县| 正定县| 松滋市| 白朗县| 分宜县|