在Spring Boot中使用swagger-bootstrap-ui

最新推荐文章于 2025-07-07 18:42:17 发布

原创

最新推荐文章于 2025-07-07 18:42:17 发布 · 置顶 · 2.4w 阅读

23 ·

CC 4.0 BY-SA版权

文章标签：

#swagger #Spring Boot #swagger-bootstrap-ui #接口文档 #doc

本文介绍了如何在Spring Boot项目中使用swagger-bootstrap-ui，它是一个增强版的Swagger UI，提供更清晰的接口浏览体验。通过引入依赖、配置Swagger的启用和分组、以及在Controller层添加注解，可以实现接口文档的展示。详细步骤包括添加jar包依赖、配置 SwaggerConfiguration 类，以及展示ctl代码层的注解使用。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

更多swagger-bootstrap-ui的详情可关注官方文档,点击前往

swagger-bootstrap-ui是基于swagger接口api实现的一套UI,因swagger原生ui是上下结构的，在浏览接口时不是很清晰,所以，swagger-bootstrap-ui是基于左右菜单风格的方式,适用与我们在开发后台系统左右结构这种风格类似,方便与接口浏览

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

用户手册：https://doc.xiaominfo.com/

欢迎大家Watch,Fork,Star

界面预览：

引入swagger

在pom.xml文件中引入swagger以及ui的jar包依赖

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>2.9.2</version>
</dependency>
<!--引入ui包-->
<dependency>
  <groupId>com.github.xiaoymin</groupId>
  <artifactId>swagger-bootstrap-ui</artifactId>
  <version>1.9.3</version>
</dependency>dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>2.9.2</version>
</dependency>

配置configuration

配置swagger的启用配置文件，关键注解@EnableSwagger2

一下配置是支持接口分组的配置，如果没有分组配置,只需要创建一个Docket即可


@Configuration
@EnableSwagger2
public class SwaggerConfiguration {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)