在做CRMEB-JAVA開(kāi)源商城系統(tǒng)時(shí)，我們團(tuán)隊(duì)用到了uni-app，也是時(shí)下比較流行的移動(dòng)端開(kāi)發(fā)技術(shù)，這里邊就牽扯到了前后端全部分離的問(wèn)題，一般在使用java開(kāi)發(fā)前后端分離項(xiàng)目的時(shí)候，都會(huì)用到Swagger，Swagger 是一個(gè)用于生成、描述、調(diào)用和可視化 RESTful 風(fēng)格的 Web api 服務(wù)的框架，Swagger 讓部署管理和使用功能強(qiáng)大的 API變得簡(jiǎn)單，但這僅僅是在小型項(xiàng)目里，API接口不多的情況下。

隨著，CRMEB-JAVA開(kāi)源商城系統(tǒng)的不斷優(yōu)化，功能的不斷增加，并且前后臺(tái)都做到了前后端分離，接口數(shù)量一度超過(guò)了200多個(gè)，這就使得系統(tǒng)中一些使用體驗(yàn)變的越來(lái)越差，例如： 提交參數(shù)為JSON沒(méi)法格式化，參數(shù)錯(cuò)了查找麻煩，返回結(jié)果沒(méi)法折疊，太長(zhǎng)了沒(méi)法看，真是非常的痛苦呀！

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

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

先上一張項(xiàng)目剛上的knife4j優(yōu)化過(guò)的Swagger的劇照，先睹為快：

看上圖是不是一目了然，最重要的是搜索框可以搜索相關(guān)api接口快速查詢，并且可以在線調(diào)試接口，再來(lái)張圖展示！

knife4j開(kāi)源項(xiàng)目說(shuō)明：

Spring Boot 項(xiàng)目使用knife4j

• 研究CRMEB_JAVA開(kāi)源商城系統(tǒng)，學(xué)習(xí)看在實(shí)際開(kāi)發(fā)當(dāng)中，如何集成進(jìn)項(xiàng)目！

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

CRMEB_JAVA開(kāi)源商城地址：

https://gitee.com/ZhongBangKeJi/crmeb_java

maven引用

第一步： 是在項(xiàng)目的pom.xml文件中引入knife4j的依賴(lài),如下：

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

如果你想使用bom的方式引入,請(qǐng)參考Maven Bom方式引用

創(chuàng)建Swagger配置文件

新建Swagger的配置文件SwaggerConfiguration.java文件,創(chuàng)建springfox提供的Docket分組對(duì)象,代碼如下：

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

訪問(wèn)

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

感謝您的閱讀，如果對(duì)您有幫助，歡迎關(guān)注CRMEB頭條號(hào)。碼云上有我們開(kāi)源的商城項(xiàng)目，知識(shí)付費(fèi)項(xiàng)目，均是基于PHP+vue+mysql開(kāi)發(fā)，學(xué)習(xí)研究歡迎使用，大家可以動(dòng)動(dòng)發(fā)財(cái)?shù)男∈贮c(diǎn)點(diǎn)Start哦，關(guān)注我不迷路！

創(chuàng)作挑戰(zhàn)賽新人創(chuàng)作獎(jiǎng)勵(lì)來(lái)咯，堅(jiān)持創(chuàng)作打卡瓜分現(xiàn)金大獎(jiǎng)

總結(jié)

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

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。