本篇文章為大家展示了Spring Boot怎樣集成Swagger-UI，內(nèi)容簡(jiǎn)明扼要并且容易理解，絕對(duì)能使你眼前一亮，通過(guò)這篇文章的詳細(xì)介紹希望你能有所收獲。
為龍口等地區(qū)用戶提供了全套網(wǎng)頁(yè)設(shè)計(jì)制作服務(wù)，及龍口網(wǎng)站建設(shè)行業(yè)解決方案。主營(yíng)業(yè)務(wù)為做網(wǎng)站、網(wǎng)站制作、龍口網(wǎng)站設(shè)計(jì)，以傳統(tǒng)方式定制建設(shè)網(wǎng)站，并提供域名空間備案等一條龍服務(wù)，秉承以專業(yè)、用心的態(tài)度為用戶提供真誠(chéng)的服務(wù)。我們深信只要達(dá)到每一位用戶的要求，就會(huì)得到認(rèn)可，從而選擇與我們長(zhǎng)期合作。這樣，我們也可以走得更遠(yuǎn)！
Swagger-UI
下面介紹如何用spring boot集成Swagger-UI，實(shí)現(xiàn)項(xiàng)目在線接口文檔的實(shí)現(xiàn)
Swagger是一個(gè)Restful風(fēng)格接口的文檔在線自動(dòng)生成和測(cè)試的框架
官網(wǎng)對(duì)Swagger-UI的介紹：
簡(jiǎn)單的說(shuō)就是：Swagger提供了一組靜態(tài)頁(yè)面，可以在SpringBoot應(yīng)用中集成這些靜態(tài)頁(yè)面，直接訪問(wèn)靜態(tài)頁(yè)面，并打開(kāi)指定的Swagger規(guī)范，就可以顯示、測(cè)試調(diào)用接口：
而在SpringBoot中集成Swagger是非常容易的，僅需增加幾個(gè)簡(jiǎn)單的注解。
效果如圖：
Swagger2Config類位于config包，用來(lái)配置swagger。
介紹一些簡(jiǎn)單的配置：
Swagger對(duì)生成API文檔的范圍有三種不同的選擇
生成指定包面的類的API文檔下
生成有指定注解的類的API文檔
生成有指定注解的方法的API文檔
三種方式如圖： 
對(duì)應(yīng)關(guān)系如圖 
常用注解
@Api：用于修飾Controller類，生成Controller相關(guān)文檔信息
@ApiOperation：用于修飾Controller類中的方法，生成接口方法相關(guān)文檔信息
@ApiParam：用于修飾接口中的參數(shù)，生成接口參數(shù)相關(guān)文檔信息
@ApiModelProperty：用于修飾實(shí)體類的屬性，當(dāng)實(shí)體類是請(qǐng)求參數(shù)或返回結(jié)果時(shí)，直接生成相關(guān)文檔信息
value - 字段說(shuō)明
description - 注釋說(shuō)明這個(gè)類
對(duì)應(yīng)：
value - 字段說(shuō)明
notes - 注釋說(shuō)明
httpMethod - 說(shuō)明這個(gè)方法被請(qǐng)求的方式
response - 方法的返回值的類型
value–字段說(shuō)明
name–重寫(xiě)屬性名字
dataType–重寫(xiě)屬性類型
required–是否必填
example–舉例說(shuō)明
hidden–隱藏
code - 響應(yīng)的HTTP狀態(tài)碼
message - 響應(yīng)的信息內(nèi)容
如項(xiàng)目集成了OAuth3或JWT等 用戶驗(yàn)證，不能直接調(diào)用需要添加 authorizations
可以從控制臺(tái)拿到，添加后就可以自由調(diào)用
http://localhost:8080/swagger-ui.html
看版本信息
http://localhost:8080/swagger-resources/
上述內(nèi)容就是Spring Boot怎樣集成Swagger-UI，你們學(xué)到知識(shí)或技能了嗎？如果還想學(xué)到更多技能或者豐富自己的知識(shí)儲(chǔ)備，歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。
重慶分公司
重慶分公司
