SpringBoot中swagger的使用

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

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

• swagger配置

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

• 常用注解

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

• 前后端分離

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

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

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

到此這篇關(guān)于SpringBoot中swagger的使用的文章就介紹到這了,更多相關(guān)swagger的使用內容請搜索腳本之家以前的文章或繼續瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！