SpringBoot集成Swagger-Bootstrap-UI，界面美觀。下面給大家介紹一下！

該開源項目GitHub地址:

https://github.com/xiaoymin/Swagger-Bootstrap-UI

該開源項目中文文檔地址:

https://doc.xiaominfo.com/

1

添加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>

2

添加配置類

package?com.blog.tutorial.config; import?com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI; import?org.springframework.context.annotation.Bean; import?org.springframework.context.annotation.Configuration; import?springfox.documentation.builders.ApiInfoBuilder; import?springfox.documentation.builders.PathSelectors; import?springfox.documentation.builders.RequestHandlerSelectors; import?springfox.documentation.service.ApiInfo; import?springfox.documentation.spi.DocumentationType; import?springfox.documentation.spring.web.plugins.Docket; import?springfox.documentation.swagger2.annotations.EnableSwagger2; /***?@description:*?@author:?youcong*?@time:?2020/11/14?15:46*/@Configuration @EnableSwagger2 @EnableSwaggerBootstrapUI public?class?SwaggerConfiguration?{@Beanpublic?Docket?createRestApi()?{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-ui?RESTful?APIs").description("swagger-bootstrap-ui").termsOfServiceUrl("http://localhost:5050/").contact("developer@mail.com").version("1.0").build();} }

3

啟動項目

啟動項目，不報錯，然后訪問地址:

http://ip:port/doc.html 即可

效果圖，如下:

測試接口，效果圖如下:

調式相當于用PostMan測試接口。

4

常用注解

和swagger一樣，swagger用的注解，swagger-bootstrap-ui仍能用。

不過結合我的開發經驗來看，最常用的也就兩個，@Api和@ApiOperation。

@Api的效果，如圖:

@ApiOperation的效果，如圖:

由此，我們很容易就看出來，它們的含義是什么，一個是接口分類說明，一個是接口方法說明。

至于這里不用swagger的參數注解，主要原因是不想加太多的注解從而增加代碼的數量，造成太多冗余。

例子中的Controller代碼:

package?com.blog.tutorial.controller; import?com.blog.tutorial.entity.Users; import?com.blog.tutorial.service.UsersService; import?io.swagger.annotations.Api; import?io.swagger.annotations.ApiOperation; import?org.springframework.beans.factory.annotation.Autowired; import?org.springframework.web.bind.annotation.GetMapping; import?org.springframework.web.bind.annotation.RequestMapping; import?org.springframework.web.bind.annotation.RestController; import?java.util.List; /***?@description:*?@author:?youcong*?@time:?2020/11/14?13:27*/@RestController @RequestMapping("/user") @Api(tags?=?{"用戶管理"},?description?=?"用戶管理") public?class?UserController?{@Autowiredprivate?UsersService?usersService;@GetMapping("/list")@ApiOperation(value?=?"用戶列表")public?List?list()?{return?usersService.list();} }

5

其它

關于swagger整合系列，可以參考如下:

https://www.cnblogs.com/youcong/p/9011302.html

關于swagger-bootstrap整合系列，可以參考:

https://www.cnblogs.com/youcong/p/9196157.html

https://www.cnblogs.com/youcong/p/10786371.html

6

可能遇到的問題

1.訪問不到接口文檔界面白版

一般是被攔截了(shiro或springsecurity機制)或者是配置錯誤。

2.訪問接口文檔界面出來了，但掃描不到接口

主要是配置類的緣故，配置類有個包掃描，必須配置為controller路徑。

如圖所示:

如果還有其它問題，可以去官方文檔上找，官方文檔有一個常規問題列表和解決方案，如圖所示:

如果問題非常奇葩的話，實在解決不了(在參考官方文檔說明和搜索的前提下，仍解決不了，把問題詳細描述和關鍵性代碼提到該開源項目的issue上，向創造者求助)。

IT技術分享社區

個人博客網站：https://programmerblog.xyz

文章推薦程序員效率：畫流程圖常用的工具程序員效率：整理常用的在線筆記軟件遠程辦公：常用的遠程協助軟件，你都知道嗎？51單片機程序下載、ISP及串口基礎知識硬件：斷路器、接觸器、繼電器基礎知識

總結

以上是生活随笔為你收集整理的后端：SpringBoot集成Swagger-Bootstrap-UI，界面美观！的全部內容，希望文章能夠幫你解決所遇到的問題。

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