springboot 整合springfox swagger2
时间: 2023-06-21 17:08:34 浏览: 253
spring boot 整合 swagger2
要在 Spring Boot 中使用 Swagger2,您可以使用 SpringFox 库。下面是将 SpringFox Swagger2 集成到 Spring Boot 项目中的步骤:
1. 在 pom.xml 文件中添加以下依赖项:
```
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
```
2. 在 Spring Boot 应用程序的主类上添加 @EnableSwagger2 注释。
```
@SpringBootApplication
@EnableSwagger2
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
```
3. 创建一个名为 SwaggerConfig 的类,并在其中创建 Docket 对象。
```
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
}
```
4. 重新启动应用程序,并访问地址 http://localhost:8080/swagger-ui.html,您将看到 Swagger UI 界面,其中包含您的 API 文档。
这就是将 Swagger2 集成到 Spring Boot 项目中的所有步骤。现在,您可以使用 Swagger2 来记录和测试您的 API。
阅读全文