springboot集成swagger2.10.5
时间: 2025-05-22 07:12:36 浏览: 14
### Spring Boot 整合 Swagger 2.10.5 示例及配置说明
#### 配置依赖
为了在Spring Boot项目中集成Swagger,在`pom.xml`文件中需引入相应的Maven依赖:
```xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
```
此版本兼容Swagger 2.x系列并提供简化配置的支持[^1]。
#### 启用Swagger功能
自Swagger 2.10.0起,官方不再推荐使用旧版的`@EnableSwagger2`注解来启用API文档生成功能。取而代之的是针对不同类型的Web应用提供了更精确的选择——对于传统的Servlet风格(即阻塞式I/O操作)的应用程序应采用`@EnableSwagger2WebMvc`;而对于响应式的Web应用程序则应该选用`@EnableSwagger2WebFlux`作为替代方案。
#### 自定义Docket Bean
通过创建一个名为`docket`的Bean实例来自定义生成的API描述信息,这通常是在Java配置类里完成的操作。下面是一个简单的例子展示如何设置基本属性如标题、描述以及联系人等细节:
```java
import org.springframework.context.annotation.Bean;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.OAS_30)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example"))
.paths(PathSelectors.any())
.build();
}
}
```
上述代码片段展示了如何指定扫描路径以便正确识别待记录下来的RESTful接口位置,并指定了所遵循的标准为OpenAPI Specification 3.0 (OAS 3.0)[^1]。
#### 访问在线文档界面
一旦完成了以上几步之后,启动Spring Boot应用程序并将浏览器指向`http://localhost:<port>/swagger-ui/index.html#/`即可查看到交互式的API文档页面[^4]。
阅读全文
相关推荐
















