swagger升级knife4j:一路上升级打怪
閑話說在前面
用過java做前后端分離的項目的老干部,基本上都受到過接口文檔的折磨。
特別是CMMI的等級比較高的,公司流程比較長的。API文檔的更新不及時和不完整,
一直是前端和后端的戰爭導火索。
swagger一出來后,基本上吵架少了很多。只要有一點項目經驗的,多少都用過swagger。
為什么?
我們像來說下
Swagger是什么?有什么用?
官網:https://swagger.io/
如果你有那份閑心,你可以仔細琢磨琢磨下原文檔。
按照通俗的話來說,Swagger的出現,極大的解放了程序員的雙手。你可以不再去琢磨word文檔的表格,字體大小....
你只要按照規范要求,給每個字段添加好對應的注釋。
如果你想更加偷懶的話,可以下載一個人人代碼生成器,它可以把注解和數據庫的字段注釋關聯起來,生成一大片的機械代碼。你至少需要簡單修改下就可以了。
然后你配置好了后,啟動了項目,把項目地址扔給前端小妹子。告訴她,在接口地址后面加上swagger-ui.html。你要的所有的接口的信息,都在上面了。
你只要寫代碼就好,剩下你不擅長的API文檔,swagger就幫你包圓了
既然它這么好?為什么人們還要看著碗里,想著鍋里的呢?
?knife4j的出生
人都是一樣的,見異思遷。有能用的,希望能有更好用的。
swagger是解放了后端的雙手,但是生成的文檔格式,樣式:特別是那種綠,綠的發光;那種黑,黑的發慌。
在國人面前看來,還有點像洋大人的味道。有點水土不服。如果你用過外國人的app,再用國人的app。您就能深深體會那種感覺了。
knife4j就是在這樣的場景下產生的。主要解決大家審美的問題。
一切以國人的方式來對頁面樣式進行了調整。
不信,你對比下樣式就知道了。
swagger原生態:
knife4j :
?是不是心情愉悅度有天壤之別?
升級之路
1、干掉所有的swagger-*相關的引用包。
? ? ? ? knife4j已經把所有的包都幫你引入了,不需要你再單獨引入。
? ? ? ? 重復的引入有可能會導致你的包沖突而報錯
2、刪除springfox-*相關的包
? ? ? ? knife4j對應的包有對應的springfox的對應的版本。不要保留了
3、參照官網的快速開始。引入對應的knife4j包。
????????https://doc.xiaominfo.com/knife4j/documentation/get_start.html
打包,上傳、啟動項目,然后告訴前端妹子:哥哥能力提升了,請將地址從swagger-ui.html換成doc.html。
至此,已經全部完成。
總結
項目的提升和優化,是一個無盡之路。需要不斷的提升自己的能力,然后在工作中不斷的釋放自己的小宇宙。
總結
以上是生活随笔為你收集整理的swagger升级knife4j:一路上升级打怪的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: CrystalReports2007安装
- 下一篇: UPS电源知识(开发板销售http://