快捷導(dǎo)航

SpringBoot中swagger的使用

更新時(shí)間：2021年05月07日 10:18:08 作者：代碼呆嘛

這篇文章主要介紹了SpringBoot中swagger的使用,文中有非常詳細(xì)的代碼示例,對(duì)正在學(xué)習(xí)swagger的小伙伴們有非常好的幫助,需要的朋友可以參考下

接口文檔對(duì)前后端開(kāi)發(fā)人員非常重要，swagger 是基于open api規(guī)范構(gòu)建開(kāi)源工具，

swagger組件有
swagger editor 基于瀏覽器編輯器，
swagger ui 可視化ui展示描述文件，
swagger inspector 和ui組件很像，可以返回更多信息，會(huì)保存請(qǐng)求實(shí)際參數(shù)，
spring fox 是可以根據(jù)代碼生成接口文檔，所以描述文件是根據(jù)項(xiàng)目來(lái)變化的，不用手動(dòng)更新，
springboot導(dǎo)入spring-fox依賴(lài)就是導(dǎo)入了wagger,
在啟動(dòng)類(lèi)上添加@EnableSwagger2注解，添加這個(gè)注解后表示啟動(dòng)項(xiàng)目就會(huì)啟動(dòng)swagger組件，對(duì)當(dāng)前項(xiàng)目全部控制器進(jìn)行掃描，
訪(fǎng)問(wèn)swagger-ui
啟動(dòng)項(xiàng)目后在瀏覽器中輸入 http://ip:port/swagger-ui.html
在swagger-ui中可視化操作項(xiàng)目接口，

swagger配置

可以在項(xiàng)目中創(chuàng)建SwaggerConfig 配置對(duì)象來(lái)進(jìn)行配置文檔內(nèi)容
Docket對(duì)象通過(guò)這個(gè)對(duì)象配置描述文件信息
通過(guò)apis()方法來(lái)設(shè)置哪些包中的內(nèi)容被掃描，

常用注解

@Api
是類(lèi)上注解控制了整個(gè)類(lèi)生成接口信息的內(nèi)容，屬性tags 類(lèi)的名字 description描述
@ApiOperation 寫(xiě)在方法上的注解，對(duì)方法進(jìn)行描述，屬性value 方法描述 notes 提示信息
@ApiParam 寫(xiě)在方法參數(shù)中的注解，用于對(duì)參數(shù)進(jìn)行描述，說(shuō)明一下是否是必填項(xiàng)，屬性有 name 參數(shù)名字 value參數(shù)描述 required是否是必須
@ApiModel是類(lèi)上注解，主要應(yīng)用在實(shí)體類(lèi)上，屬性value 類(lèi)名稱(chēng)，description 是描述
@ApiModelproperty可以應(yīng)用在方法上或是屬性上，用于方法參數(shù)是應(yīng)用類(lèi)型時(shí)進(jìn)行定義描述
@Apilgnore 用于類(lèi)上方法上參數(shù)上，表示被忽視，

前后端分離

一般使用vue+springboot
后端：后端控制層服務(wù)層數(shù)據(jù)訪(fǎng)問(wèn)層
前端：前端控制層視圖層
前后端交互 API
創(chuàng)建springboot項(xiàng)目導(dǎo)入對(duì)應(yīng)的依賴(lài)

在這里插入圖片描述

啟動(dòng)swagger界面查看

在這里插入圖片描述

配置swagger
swagger有自己的配置實(shí)例對(duì)象 Docket
這個(gè)對(duì)象方法中有多個(gè)屬性
apiinfo屬性是配置swagger顯示的信息
select()配置掃描接口
groupname()配置api文檔的分組配置多個(gè)Docket實(shí)例可以實(shí)現(xiàn)多個(gè)分組，多個(gè)@bean

在這里插入圖片描述