springboot引入swagger3
时间: 2024-03-29 12:33:08 浏览: 122
当使用Spring Boot开发RESTful API时,Swagger是一个非常有用的工具,它可以帮助我们生成API文档并提供交互式的API测试界面。在Spring Boot中引入Swagger3可以按照以下步骤进行:
1. 首先,在项目的`pom.xml`文件中添加Swagger3的依赖:
```xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
```
2. 创建一个Swagger配置类,用于配置Swagger相关的信息。可以创建一个名为`SwaggerConfig`的类,并使用`@Configuration`注解标记该类为配置类。在该类中,可以使用`@Bean`注解创建一个`Docket`对象,用于配置Swagger的基本信息,例如API文档的标题、描述等。以下是一个示例配置:
```java
@Configuration
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.api"))
.paths(PathSelectors.any())
.build()
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("API文档")
.description("这是一个示例API文档")
.version("1.0.0")
.build();
}
}
```
3. 启动应用程序,并访问`http://localhost:8080/swagger-ui/`,将会看到生成的API文档和交互式的API测试界面。
阅读全文