Spring Boot 集成 Swagger-Bootstrap-UI非常棒的解決方案

SpringBoot集成Swagger-Bootstrap-UI，非常棒的解決方案之前在創(chuàng)業(yè)公司待的時候，用過swagger，因為我第一天來這家公司工作，第一個任務就是做接口文檔自動化。后來覺得它不太好用，在瀏覽技術網(wǎng)站的時候，偶然發(fā)現(xiàn)swagger-bootstrap-ui，于是便重構了，把swagger-bootstrap-ui整合進來，后來發(fā)現(xiàn)不僅僅對我們后端有幫助，主要方便我們將接口進行歸類，同樣對安卓小伙伴也有幫助，他們可以看這個接口文檔進行聯(lián)調。當初我使用swagger-boostrap-ui的時候，那個時候還是1.x版本，如今swagger-bootsrap-ui到2.x，同時也更改名字knife4j，適用場景從過去的單體到微服務。也算是見證咱們國人自己的開源項目從小到大。PS：如果需要Swagger相關的教程，可以關注公眾號「Java后端」獲取推送。該開源項目GitHub地址:/xiaoymin/Swagger-Bootstrap-UI該開源項目中文文檔地址:一、添加Maven依賴<dependency>

<groupId>io.springfoxgroupId>

<artifactId>springfox-swagger2artifactId>

<version>2.9.2version>

dependency>

<dependency>

<groupId>com.github.xiaoymingroupId>

<artifactId>swagger-bootstrap-uiartifactId>

<version>1.9.6version>

dependency>二、添加配置類@Configuration

@EnableSwagger2

@EnableSwaggerBootstrapUI

publicclassSwaggerConfiguration{

@Bean

publicDocketcreateRestApi(){

return

new

Docket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())

.select()

.apis(RequestHandlerSelectors.basePackage("com.blog.tutorial.controller"))

.paths(PathSelectors.any())

.build();

}

private

ApiInfo

apiInfo(){

return

new

ApiInfoBuilder()

.title("swagger-bootstrap-uiRESTfulAPIs")

.description("swagger-bootstrap-ui")

.termsOfServiceUrl("http://localhost:5050/")

.contact("developer@")

.version("1.0")

.build();

}

}三、啟動項目啟動項目，不報錯，然后訪問地址:http://ip:port/doc.html即可,

效果圖，如下:在公眾號后端架構師后臺回復“架構整潔”，獲取一份驚喜禮包。測試接口，效果圖如下:調式相當于用PostMan測試接口。四、常用注解和swagger一樣，swagger用的注解，swagger-bootstrap-ui仍能用。

不過結合我的開發(fā)經(jīng)驗來看，最常用的也就兩個，@Api和@ApiOperation。

@Api的效果，如圖:@ApiOperation的效果，如圖:由此，我們很容易就看出來，它們的含義是什么，一個是接口分類說明，一個是接口方法說明。至于這里不用swagger的參數(shù)注解，主要原因是不想加太多的注解從而增加代碼的數(shù)量，造成太多冗余。例子中的Controller代碼:@RestController

@RequestMapping("/user")

@Api(tags={"用戶管理"},description=

"用戶管理")

publicclassUserController{

@Autowired

privateUsersServiceusersService;

@GetMapping("/list")

@ApiOperation(value=

"用戶列表")

publicListlist(){

return

usersService.list();

}

}五、其它補充/youcong/p/9196157.html/youcong/p/9196157.html六、可能遇到的問題1.訪問不到接口文檔界面白版一般是被攔截了(shiro或springsecurity機制)或者是配置錯誤。2.訪問接口文檔界面出來了，但掃描不到接口主要是配置類的緣故，配置類有個包掃描，必須配置為controller路徑。如圖所示:如果還有其它問題，可以去