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

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

• swagger配置

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

• 常用注解

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

• 前后端分離

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

啟動swagger界面查看

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

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

最新評論