集成Swagger和Swagger-Bootstrap-UI并使用常见注解的Spring Boot项目

228 篇文章 ¥59.90 ¥99.00
本文介绍了如何在Spring Boot项目中集成Swagger和Swagger-Bootstrap-UI,以生成API文档并进行交互式测试。通过添加依赖、创建配置类、使用Swagger注解,展示了如何描述和展示API接口,并提供了访问Swagger-Bootstrap-UI界面的方法。

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

Swagger是一种用于构建、文档化和调试RESTful API的开源工具。它提供了一个交互式的界面,可以方便地查看和测试API的各种操作。Swagger-Bootstrap-UI是Swagger的一个增强UI界面,提供了更好的可视化效果和更多的功能。

在Spring Boot项目中,我们可以通过集成Swagger和Swagger-Bootstrap-UI来生成API文档,并在浏览器中进行交互式测试。下面将详细介绍如何集成Swagger和Swagger-Bootstrap-UI,并展示一些常见的Swagger注解的使用示例。

  1. 添加Swagger和Swagger-Bootstrap-UI依赖

首先,在项目的pom.xml文件中添加Swagger和Swagger-Bootstrap-UI的依赖。可以使用以下依赖:

<dependency>
    <groupId>io.springfox
<think>嗯,用户想了解在Spring Boot 2.2.2.RELEASE中集成Swagger-Bootstrap-UI的教程。首先,我需要回忆一下SwaggerSwagger-Bootstrap-UI的基本概念。Swagger是用来生成API文档的工具,而Swagger-Bootstrap-UI是它的一个美化版本,界面更友好。 接下来,用户提到的Spring Boot版本是2.2.2.RELEASE,这个版本可能对依赖库有特定要求。我需要确认SwaggerSwagger-Bootstrap-UI在这个Spring Boot版本中的兼容性。通常,Springfox Swagger2Swagger UI的版本需要匹配,可能使用2.9.2或者更高版本。 然后,步骤方面,应该包括添加Maven依赖、配置Swagger、初始化配置类,以及如何访问生成的文档。可能需要参考用户提供的引用内容中的配置类,比如使用@Configuration注解的类,以及如何定义Docket bean。 另外,用户提供的引用中有User实体类,可能需要考虑在API文档中如何展示实体类,可能需要添加@ApiModel注解之类的。不过用户的问题主要集中在集成过程,所以可能不需要深入实体类的部分。 需要注意的点:是否正确引入了Swagger-Bootstrap-UI的依赖,是否需要在配置类中启用Swagger,以及可能的版本冲突问题。比如,Spring Boot 2.2.2可能使用较新的Spring框架版本,需要确保Swagger相关库与之兼容。 还有,生成的文档访问路径是什么,是否需要额外的安全配置,比如在Spring Security中放行相关路径。但用户的问题中没有提到安全框架,可能暂时不需要涉及。 最后,验证步骤是否完整,比如启动应用后访问/doc.html是否能正常看到美化后的界面。可能还需要测试一些API接口是否被正确收录展示。</think>### Spring Boot 2.2.2.RELEASE集成Swagger-Bootstrap-UI教程 #### 1. 添加依赖 在`pom.xml`中引入以下依赖: ```xml <!-- Springfox Swagger2核心库 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <!-- Swagger-Bootstrap-UI美化包 --> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>swagger-bootstrap-ui</artifactId> <version>1.9.6</version> </dependency> ``` #### 2. 创建Swagger配置类 ```java @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.example.controller")) // 修改为你的控制器包路径 .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("API文档") .description("Spring Boot 2.2.2集成Swagger-Bootstrap-UI示例") .version("1.0") .build(); } } ``` *注:配置类需使用@Configuration注解标识[^1]* #### 3. 实体类配置(可选) 若需展示实体类文档,可在User类添加注解: ```java @ApiModel("用户实体") @Getter @Setter @ToString public class User implements Serializable { @ApiModelProperty("登录名") private String loginName; @ApiModelProperty("密码") private String password; } ``` *参考用户实体类结构[^2]* #### 4. 访问文档 启动应用后访问: - 原生UI:`http://localhost:8080/swagger-ui.html` - 美化UI:`http://localhost:8080/doc.html` #### 5. 常见问题处理 1. **版本兼容性**:确保Spring BootSwagger版本匹配 2. **路径扫描**:检查`basePackage`配置是否正确 3. **静态资源拦截**:若使用MVC拦截器需排除`/v2/api-docs``/doc.html`路径
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值