天天看點

knife4j的學習

https://www.toutiao.com/a6789135368064074253/?tt_from=mobile_qq&utm_campaign=client_share&timestamp=1580865623&app=news_article&utm_source=mobile_qq&utm_medium=toutiao_android&req_id=202002050920230101290351361F94FA5D&group_id=6789135368064074253

knife4j是為Java MVC架構內建Swagger生成Api文檔的增強解決方案(在非Java項目中也提供了前端UI的增強解決方案),前身是swagger-bootstrap-ui,取名knife4j是希望她能像一把匕首一樣小巧,輕量,并且功能強悍!

knife4j的學習

開源倉庫

Github

碼雲

功能特性

簡潔

基于左右菜單式的布局方式,是更符合國人的操作習慣吧.文檔更清晰...

個性化配置

個性化配置項,支援接口位址、接口description屬性、UI增強等個性化配置功能...

增強

接口排序、Swagger資源保護、導出Markdown、參數緩存衆多強大功能...

功能預覽

線上預覽

選擇不同接口

knife4j的學習

Authorize

knife4j的學習

swagger實體

包含了swagger實體的相關資訊

knife4j的學習

swagger全局設定

全局參數設定

knife4j的學習
knife4j的學習

離線文檔導出

Knife4j提供導出4種格式的離線文檔(Html\Markdown\Word\Pdf)

knife4j的學習

個性化設定

knife4j的學習

api文檔

knife4j的學習
knife4j的學習

搜尋功能

knife4j的學習

使用簡介

項目結構

knife4j的學習

目前主要的子產品

單純皮膚增強

不使用增強功能,純粹換一個swagger的前端皮膚,這種情況是最簡單的,你項目結構下無需變更

可以直接引用swagger-bootstrap-ui的最後一個版本1.9.6或者使用knife4j-spring-ui

老版本引用

新版本引用

Spring Boot項目單體架構使用增強功能

在Spring Boot單體架構下,knife4j提供了starter供開發者快速使用

該包會引用所有的knife4j提供的資源,包括前端Ui的jar包

Spring Cloud微服務架構

在Spring Cloud的微服務架構下,每個微服務其實并不需要引入前端的Ui資源,是以在每個微服務的Spring Boot項目下,引入knife4j提供的微服務starter

在網關聚合文檔服務下,可以再把前端的ui資源引入

總結

針對knife4j的總結,無非就是牛逼來形容,切實的解決了swagger ui不夠友好的問題,而且還可以內建到其他語言的api項目中,真真切切的需要感謝開發作者提供了這麼好的工具供我們使用,小夥伴是不是心動了,趕緊去試試吧!enjoy it!

繼續閱讀