本篇內(nèi)容主要講解“Swagger增強(qiáng)神器:Knife4j有哪些作用”,感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷,實用性強(qiáng)。下面就讓小編來帶大家學(xué)習(xí)“Swagger增強(qiáng)神器:Knife4j有哪些作用”吧!
成都創(chuàng)新互聯(lián)是一家專業(yè)提供即墨企業(yè)網(wǎng)站建設(shè),專注與網(wǎng)站設(shè)計制作、成都網(wǎng)站制作、H5場景定制、小程序制作等業(yè)務(wù)。10年已為即墨眾多企業(yè)、政府機(jī)構(gòu)等服務(wù)。創(chuàng)新互聯(lián)專業(yè)網(wǎng)站設(shè)計公司優(yōu)惠進(jìn)行中。
wagger 是開發(fā)中最常用的框架之一了,但 Swagger 本身又有很多不完善的地方,比如,在眾多的接口中查詢某一個接口,又或者是把所有的接口導(dǎo)出成 Word 格式等,都無法在 Swagger 中實現(xiàn)。
有人可能會問:為什么要把接口導(dǎo)成 Word 格式?這種場景還挺常見的,比如需要將接口對外部公司開放時,又或者是開發(fā)環(huán)境的網(wǎng)絡(luò)不能對外部開放(如專線,很多醫(yī)院都拉的是專線),而生產(chǎn)環(huán)境的 Swagger 又是關(guān)閉狀態(tài)的時候,這時候只能依賴離線文檔來實現(xiàn)接口的調(diào)用了,而離線文檔最常用的格式便是 Word 了。
那么為了解決 Swagger 的這些問題,我們需要使用一個 Swagger 的增強(qiáng)工具來實現(xiàn),而這個擴(kuò)展工具就是我們今天要重點介紹的 Knife4j,那 Knife4j 長得是什么樣呢?我們一起來看,如下圖所示:
圖片從這個主頁可以看出,Knife4j 會將 Swagger 中設(shè)置的摘要信息(Docket)顯示在歡迎頁,Docket 的設(shè)置可以看我之前的文章,并且 Knife4j 還很貼心的提供了一個統(tǒng)計所有接口的功能,在歡迎頁的最下方我們可以很清楚的看到當(dāng)前 POST 接口的數(shù)量,以及 GET 的接口的數(shù)量。
PS:Knife4j 支持中文和英文兩種語言展示,對于國內(nèi)的小伙伴來說,可讀性非常的高(因為都是中文的嘛)。
Knife4j 功能介紹
1.搜索功能
我覺得 Knife4j 最實用的一個功能就是“接口搜索”了,通過這個功能我們可以非常方便的找到我們需要的接口,如下圖所示:
2.離線文檔下載
Knife4j 提供了 4 種格式的離線文檔下載:Markdown、Html、Word、OpenAPI 等方式,如下圖所示:
3.接口過濾
可以通過 Knife4j 過濾某一類型的接口,比如過濾 GET 或者 POST 接口,如下圖所示:
4.全局參數(shù)設(shè)置
如果有公共的請求參數(shù),我們可以通過 Knife4j 輕松搞定,如下圖所示:
5.更友好的接口調(diào)試
使用 Knife4j 可以更友好的實現(xiàn)接口調(diào)試,因為在使用 Knife4j 時,它會將必傳的參數(shù)以紅色邊框的方式顯示,這樣我們就直觀的區(qū)分開必填參數(shù)和非必填參數(shù)了,如下圖所示:
Knife4j 使用配置
從上面的內(nèi)容可以看出 knife4j 的功能是很強(qiáng)大的,但令我更驚喜的是它的配置異常的簡單,我們只需在已經(jīng)成功配置了 Swagger 的項目中,添加 Knife4j 的依賴即可,配置信息如下:
<!-- https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j-spring-boot-starter --> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>3.0.2</version> </dependency>
經(jīng)過以上簡單的依賴添加之后,無需配置任何內(nèi)容,我們就可以成功的使用 Knife4j 了。
訪問 Knife4j
我們可以通過 http://localhost:8080/doc.html 訪問 Knife4j 的主頁,如下圖所示:
到此,相信大家對“Swagger增強(qiáng)神器:Knife4j有哪些作用”有了更深的了解,不妨來實際操作一番吧!這里是創(chuàng)新互聯(lián)網(wǎng)站,更多相關(guān)內(nèi)容可以進(jìn)入相關(guān)頻道進(jìn)行查詢,關(guān)注我們,繼續(xù)學(xué)習(xí)!
當(dāng)前文章:Swagger增強(qiáng)神器:Knife4j有哪些作用
本文鏈接:http://chinadenli.net/article46/jgihhg.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供企業(yè)建站、品牌網(wǎng)站建設(shè)、做網(wǎng)站、App開發(fā)、定制開發(fā)、響應(yīng)式網(wǎng)站
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請盡快告知,我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場,如需處理請聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時需注明來源: 創(chuàng)新互聯(lián)