在做CRMEB-JAVA開源商城系統時，我們團隊用到了uni-app，也是時下比較流行的移動端開發技術，這里邊就牽扯到了前后端全部分離的問題，一般在使用java開發前后端分離項目的時候，都會用到Swagger，Swagger 是一個用于生成、描述、調用和可視化 RESTful 風格的 Web api 服務的框架，Swagger 讓部署管理和使用功能強大的 API變得簡單，但這僅僅是在小型項目里，API接口不多的情況下。

隨著，CRMEB-JAVA開源商城系統的不斷優化，功能的不斷增加，并且前后臺都做到了前后端分離，接口數量一度超過了200多個，這就使得系統中一些使用體驗變的越來越差，例如： 提交參數為JSON沒法格式化，參數錯了查找麻煩，返回結果沒法折疊，太長了沒法看，真是非常的痛苦呀！

但是，作為程序員一定要知道，你遇到的問題別人也一定遇到過，也肯定有熱心的大牛解決了這個問題，所以，一個叫knife4j的增強版本Swagger誕生了，他幫我們很好地解決了以上問題，引用一下原作者的話來簡單了解下knife4j：

希望knife4j像一把匕首一樣小巧,輕量,并且功能強悍,也希望把她做成一個為Swagger接口文檔服務的通用性解決方案,而不僅僅只是專注于前端Ui前端.

先上一張項目剛上的knife4j優化過的Swagger的劇照，先睹為快：

看上圖是不是一目了然，最重要的是搜索框可以搜索相關api接口快速查詢，并且可以在線調試接口，再來張圖展示！

knife4j開源項目說明：

Spring Boot 項目使用knife4j

• 研究CRMEB_JAVA開源商城系統，學習看在實際開發當中，如何集成進項目！

# 幫助文檔https://doc.xiaominfo.com/knife4j/springboot.html#maven%E5%BC%95%E7%94%A8

CRMEB_JAVA開源商城地址：

https://gitee.com/ZhongBangKeJi/crmeb_java

maven引用

第一步： 是在項目的pom.xml文件中引入knife4j的依賴,如下：

com.github.xiaoymin knife4j-spring-boot-starter 2.0.2

如果你想使用bom的方式引入,請參考Maven Bom方式引用

創建Swagger配置文件

新建Swagger的配置文件SwaggerConfiguration.java文件,創建springfox提供的Docket分組對象,代碼如下：

@Configuration@EnableSwagger2@EnableKnife4j@Import(BeanValidatorPluginsConfiguration.class)public class SwaggerConfiguration { @Bean(value = "defaultApi2") public Docket defaultApi2() { Docket docket=new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) //分組名稱 .groupName("2.X版本") .select() //這里指定Controller掃描包路徑 .apis(RequestHandlerSelectors.basePackage("com.swagger.bootstrap.ui.demo.new2")) .paths(PathSelectors.any()) .build(); return docket; }}

訪問

• 在瀏覽器輸入地址：http://host:port/doc.html

感謝您的閱讀，如果對您有幫助，歡迎關注CRMEB頭條號。碼云上有我們開源的商城項目，知識付費項目，均是基于PHP+vue+mysql開發，學習研究歡迎使用，大家可以動動發財的小手點點Start哦，關注我不迷路！

創作挑戰賽新人創作獎勵來咯，堅持創作打卡瓜分現金大獎

總結

以上是生活随笔為你收集整理的java api帮助文档_JAVA的Swagger界面丑、功能弱怎么破？的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。