如何配置swagger
时间: 2023-11-16 12:52:11 浏览: 187
Swagger配置.rar
要配置Swagger,您需要完成以下步骤:
1. 首先,您需要在项目的pom.xml文件中添加Swagger的依赖库。在<dependencies>标签中添加以下代码:
```
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
```
2. 接下来,您需要创建一个Swagger的配置类。在这个类上添加@Configuration和@EnableSwagger2注解。然后创建一个名为productApi的方法并添加@Bean注解。在该方法中,使用Docket类构建一个Docket实例,并设置文档类型为SWAGGER_2。您还可以通过apiInfo方法设置文档的标题、描述和版本等信息。
示例代码如下:
```java
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket productApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("swagger和springBoot整合")
.description("swagger的API文档")
.version("1.0")
.build();
}
}
```
3. 最后,在项目中的控制器(Controller)类或接口方法上使用Swagger的注解。这些注解包括@Api、@ApiOperation、@ApiParam等,用于定义接口的信息、描述和参数。
完成上述步骤后,您可以访问本地链接(一般是http://localhost:8080/swagger-ui.html)来查看您的Swagger文档。
请注意,您需要运行项目,确保Swagger配置被正确加载。
阅读全文