SpringBoot整合Swagger2以及Swagger-Bootstrap-Ui的使用摘要

背景与优势

本篇文章介绍了如何使用Swagger2和Swagger-Bootstrap-Ui整合SpringBoot项目以简化API测试与文档维护。传统的API测试方式如单元测试、Postman等虽然有效，却无法解决与前端交互时文档维护难题。Swagger通过将代码维护和文档修改融为一体，并提供可视化测试界面，显著提升开发效率。其主要优点包括生成API文档、跨语言支持及前端测试功能。

引入Swagger依赖与配置

为了整合Swagger，需要在项目中引入以下依赖：

• springfox-swagger2
• springfox-swagger-ui

然后创建配置类 Swagger2Config，通过注解 @Configuration 和 @EnableSwagger2 启用Swagger功能。配置类中定义了API文档的基本信息与扫描路径。

定义测试API

通过注解 @ApiModel 和 @ApiModelProperty 对实体类属性进行详细描述。例如，定义了一个 Student 实体类来演示增删改查操作。然后，在控制器中使用 @Api、@ApiOperation、@ApiImplicitParams 等注解定义接口及其参数说明，便于文档生成和测试。

运行与测试

启动项目后，可以通过 http://localhost:8080/swagger-ui.html 访问Swagger界面并测试API。在界面中点击 Try it out 测试按钮，输入参数后执行接口请求。

整合Swagger-Bootstrap-Ui

默认的Swagger界面采用上下结构，不符合左右菜单风格的需求。通过引入 swagger-bootstrap-ui 依赖，可以将文档界面改为左右菜单风格。修改依赖后，访问 http://localhost:8080/doc.html 即可体验新的界面效果。

总结

通过整合Swagger2和Swagger-Bootstrap-Ui，可以显著提高SpringBoot项目的API开发效率，减少文档维护成本，并为前后端交互提供便捷的测试平台。如果本文内容对您有帮助，欢迎点赞、收藏与分享！

测试开发之系统篇-Docker常用操作

了解更多

springboot葵花宝典

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

文章来源：

springboot葵花宝典

扫码关注公众号