SpringBoot使用swagger3
时间: 2024-12-18 20:14:01 浏览: 7
Spring Boot整合Swagger 3是一个常见的实践,它可以帮助你快速生成API文档,并提供RESTful服务的交互式浏览功能。以下是简单的步骤:
1. 添加依赖:在`pom.xml`文件中添加Swagger 3的依赖,例如使用Springfox库:
```xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter-swagger2</artifactId>
<version>3.x.x</version> <!-- 更新到最新版本 -->
</dependency>
```
2. 配置:在Spring Boot应用中,通常会配置一个 SwaggerConfig 类,其中初始化Swagger实例并设置基本路径:
```java
@EnableSwagger2WebMvc
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
}
```
3. 自动扫描:确保你的Controller和处理程序被Spring的扫描器自动扫描到,以便Swagger能够发现它们。
4. 访问API文档:启动应用后,访问`http://localhost:8080/swagger-ui.html`,即可看到生成的API文档页面。
阅读全文