SpringBoot中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)行掃描，
訪問(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ù)訪問(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
到此這篇關(guān)于SpringBoot中swagger的使用的文章就介紹到這了,更多相關(guān)swagger的使用內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
Java使用CountDownLatch實(shí)現(xiàn)網(wǎng)絡(luò)同步請(qǐng)求的示例代碼
CountDownLatch 是一個(gè)同步工具類(lèi)，用來(lái)協(xié)調(diào)多個(gè)線程之間的同步，它能夠使一個(gè)線程在等待另外一些線程完成各自工作之后，再繼續(xù)執(zhí)行。被將利用CountDownLatch實(shí)現(xiàn)網(wǎng)絡(luò)同步請(qǐng)求，異步同時(shí)獲取商品信息組裝，感興趣的可以了解一下2023-01-01
這篇文章主要為大家詳細(xì)介紹了Java語(yǔ)言中的抽象類(lèi)與繼承的相關(guān)資料，文中的示例代碼講解詳細(xì)，對(duì)我們學(xué)習(xí)Java有一定的幫助，感興趣的小伙伴快跟隨小編一起了解一下2022-10-10
這篇文章主要介紹了java的equals和==的比較示例,需要的朋友可以參考下2014-04-04
springboot對(duì)數(shù)據(jù)庫(kù)密碼加密的實(shí)現(xiàn)
這篇文章主要介紹了springboot對(duì)數(shù)據(jù)庫(kù)密碼加密的實(shí)現(xiàn)，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-12-12
這篇文章主要介紹了Java中Lambda表達(dá)式使用及詳解,lambda運(yùn)行將函數(shù)作為一個(gè)方法的參數(shù)，也就是函數(shù)作為參數(shù)傳遞到方法中，使用lambda表達(dá)式可以讓代碼更加簡(jiǎn)潔，需要的朋友可以參考下2023-04-04
在Eclipse中部署Spring Boot/Spring Cloud應(yīng)用到阿里云
這篇文章主要介紹了在Eclipse中部署Spring Boot/Spring Cloud應(yīng)用到阿里云，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2018-12-12
深入學(xué)習(xí)Java 動(dòng)態(tài)代理
Java 動(dòng)態(tài)代理機(jī)制的出現(xiàn)，使得 Java 開(kāi)發(fā)人員不用手工編寫(xiě)代理類(lèi)，只要簡(jiǎn)單地指定一組接口及委托類(lèi)對(duì)象，便能動(dòng)態(tài)地獲得代理類(lèi)。下面小編和大家來(lái)一起學(xué)習(xí)一下吧2019-05-05
Springboot項(xiàng)目的Mapper中增加一個(gè)新的sql語(yǔ)句
本文主要介紹了Springboot項(xiàng)目的Mapper中增加一個(gè)新的sql語(yǔ)句,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2024-05-05
java中的export方法實(shí)現(xiàn)導(dǎo)出excel文件
這篇文章主要介紹了java中的export方法實(shí)現(xiàn)導(dǎo)出excel文件，文章圍繞java導(dǎo)出excel文件的相關(guān)資料展開(kāi)詳細(xì)內(nèi)容，需要的小伙伴可以參考一下2022-03-03
自定義Jackson的ObjectMapper如何實(shí)現(xiàn)@ResponseBody的自定義渲染
這篇文章主要介紹了自定義Jackson的ObjectMapper如何實(shí)現(xiàn)@ResponseBody的自定義渲染,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-07-07