Java中Swagger框架的使用詳解
簡(jiǎn)介
- 由于架構(gòu)革新,進(jìn)入了前后端分離,服務(wù)端只需提供RESTful API的時(shí)代。
- 而構(gòu)建RESTful API會(huì)考慮到多終端的問(wèn)題,這樣就需要面對(duì)多個(gè)開(kāi)發(fā)人員甚至多個(gè)開(kāi)發(fā)團(tuán)隊(duì)。
- 為了減少與其他團(tuán)隊(duì)對(duì)接的溝通成本,我們通常會(huì)寫好對(duì)應(yīng)的API接口文檔。
- 從最早開(kāi)始的word文檔,到后續(xù)的showdoc,都能減少很多溝通成本,但隨之帶來(lái)的問(wèn)題也比較麻煩。在開(kāi)發(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高并發(fā)編程之CAS實(shí)現(xiàn)無(wú)鎖隊(duì)列代碼實(shí)例
這篇文章主要介紹了Java高并發(fā)編程之CAS實(shí)現(xiàn)無(wú)鎖隊(duì)列代碼實(shí)例,在多線程操作中,我們通常會(huì)添加鎖來(lái)保證線程的安全,那么這樣勢(shì)必會(huì)影響程序的性能,那么為了解決這一問(wèn)題,于是就有了在無(wú)鎖操作的情況下依然能夠保證線程的安全,需要的朋友可以參考下2023-12-12SpringBoot集成Redis之配置、序列化與持久化方式
本文介紹了Redis的基本概念、常用數(shù)據(jù)類型及操作、SpringBoot整合Redis的方法、高級(jí)特性與安全性、性能優(yōu)化、測(cè)試與部署、數(shù)據(jù)一致性及版本更新等內(nèi)容,通過(guò)本文的學(xué)習(xí),讀者可以掌握Redis的使用方法,并在實(shí)際項(xiàng)目中發(fā)揮其優(yōu)勢(shì)2024-11-11SpringBoot啟動(dòng)后執(zhí)行方法的五種實(shí)現(xiàn)方式
本文介紹了SpringBoot中五種在項(xiàng)目啟動(dòng)后執(zhí)行方法的方式,包括實(shí)現(xiàn)CommandLineRunner和ApplicationRunner接口、實(shí)現(xiàn)ApplicationListener接口、使用@PostConstruct注解以及實(shí)現(xiàn)InitializingBean接口,每種方式都有其特點(diǎn)和適用場(chǎng)景2025-02-02java快速排序和選擇排序?qū)崿F(xiàn)實(shí)例解析
這篇文章主要為大家介紹了java快速排序和選擇排序?qū)崿F(xiàn)實(shí)例解析,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-11-11Java項(xiàng)目部署的完整流程(超詳細(xì)!)
我相信很多Java新手都會(huì)遇到這樣一個(gè)問(wèn)題,跟著教材敲代碼,很容易,但是讓他完整的實(shí)現(xiàn)一個(gè)應(yīng)用項(xiàng)目卻不會(huì),下面這篇文章主要給大家介紹了關(guān)于Java項(xiàng)目部署的完整流程,需要的朋友可以參考下2022-07-07SpringBoot動(dòng)態(tài)定時(shí)功能實(shí)現(xiàn)方案詳解
在SpringBoot項(xiàng)目中簡(jiǎn)單使用定時(shí)任務(wù),不過(guò)由于要借助cron表達(dá)式且都提前定義好放在配置文件里,不能在項(xiàng)目運(yùn)行中動(dòng)態(tài)修改任務(wù)執(zhí)行時(shí)間,實(shí)在不太靈活。現(xiàn)在我們就來(lái)實(shí)現(xiàn)可以動(dòng)態(tài)修改cron表達(dá)式的定時(shí)任務(wù),感興趣的可以了解一下2022-11-11