springboot项目整合swagger文档
时间: 2023-09-06 09:09:24 浏览: 150
Spring Boot 项目可以很方便地整合 Swagger 文档,只需要按照以下步骤进行操作即可。
1. 在 `pom.xml` 文件中添加 Swagger 的依赖:
```xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${springfox-version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${springfox-version}</version>
</dependency>
```
其中 `${springfox-version}` 是 Swagger 的版本号,可以根据需要进行修改。
2. 创建 Swagger 配置类,例如 `SwaggerConfig.java`:
```java
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
.paths(PathSelectors.any())
.build();
}
}
```
其中 `RequestHandlerSelectors.basePackage` 指定了扫描哪个包下的控制器类,可以根据实际情况修改。
3. 启动项目,访问 `http://localhost:8080/swagger-ui.html` 即可看到 Swagger 文档页面。
以上就是在 Spring Boot 项目中整合 Swagger 文档的简单步骤,希望能对你有所帮助。
阅读全文