springboot整合swapper
时间: 2023-09-04 07:06:19 浏览: 148
你好!要将Spring Boot与Swagger集成,你可以按照以下步骤操作:
1. 添加Swagger依赖:在你的Spring Boot项目的`pom.xml`文件中添加以下依赖:
```xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
```
2. 创建Swagger配置类:在你的Spring Boot项目中创建一个配置类,例如`SwaggerConfig.java`,并添加以下内容:
```java
import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
}
```
3. 配置Swagger信息:在上述配置类中,你可以添加更多的Swagger配置信息,例如API文档的标题、描述等。以下是一个示例:
```java
import org.springframework.context.annotation.Bean;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.controller"))
.paths(PathSelectors.any())
.build()
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("API Documentation")
.description("API Documentation for my Spring Boot project")
.version("1.0.0")
.build();
}
}
```
在上面的示例中,你需要将`com.example.controller`替换为你的控制器类所在的包路径。
4. 启动应用程序并访问Swagger UI:在你的Spring Boot应用程序启动后,你可以通过访问`http://localhost:8080/swagger-ui.html`来查看生成的API文档。在Swagger UI中,你可以浏览和测试你的API。
这就是将Spring Boot与Swagger集成的基本步骤。你可以根据需要进一步自定义Swagger配置。希望能对你有所帮助!如果你还有其他问题,请随时提问。
阅读全文