​SpringBoot-25-SpringBoot整合Swagger2以及Swagger-Bootstrap-Ui的使用

摘要

本文介绍了如何在Spring Boot应用中整合Swagger2及Swagger-Bootstrap-Ui来自动生成API文档和提供API测试界面。Swagger的主要优点包括减少创建文档的麻烦，提供前端界面测试API接口，以及跨语言支持。

引入Swagger依赖

首先需要在项目的pom.xml文件中添加SpringFox的swagger2和swagger-ui依赖。

创建Swagger配置类

接下来，创建一个Swagger配置类，使用@Configuration和@EnableSwagger2注解来启用Swagger，并配置Docket Bean以扫描生成API文档的controller路径。

配置Swagger测试API

文档展示了如何使用@ApiModel和@ApiModelProperty注解来描述实体类及其属性，以及如何使用@Api和@ApiOperation注解添加Controller来生成具体的API文档和测试接口。

测试

启动项目后，通过访问指定的URL（http://localhost:8080/swagger-ui.html）可以看到Swagger界面，并进行API测试。

整合swagger-bootstrap-ui

为了获得更符合开发习惯的左右菜单风格的UI，可以引入swagger-bootstrap-ui依赖，并通过访问新的URL（http://localhost:8080/doc.html）来查看更新后的Swagger文档。

文章最后提醒读者原创不易，转载请注明出处，并欢迎读者通过关注、点赞和收藏来支持作者。

想要了解更多内容？

查看原文：​SpringBoot-25-SpringBoot整合Swagger2以及Swagger-Bootstrap-Ui的使用

文章来源：

springboot葵花宝典

扫码关注公众号