spring boot 配置swagger2
要在Spring Boot中配置Swagger2,需要执行以下步骤:
- 添加Swagger2依赖:在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>
- 创建Swagger2配置类:创建一个类,并使用
@Configuration和@EnableSwagger2注解将其标记为配置类,并实现WebMvcConfigurer接口。
@Configuration
@EnableSwagger2
public class SwaggerConfig implements WebMvcConfigurer {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.controller"))
.paths(PathSelectors.any())
.build();
}
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}
其中,api()方法用于配置Swagger的基本信息,如扫描的包、API路径等。addResourceHandlers()方法用于配置Swagger UI的资源路径。
- 配置Swagger的访问路径:在
application.properties文件中添加以下配置:
# Swagger
swagger.enabled=true
这将启用Swagger,并将其默认配置应用于应用程序。
- 启动应用程序并访问Swagger UI:启动应用程序后,可以通过访问
http://localhost:8080/swagger-ui.html来查看生成的API文档。
以上是在Spring Boot中配置Swagger2的基本步骤。你可以根据自己的需要进行进一步的配置和定制化
原文地址: https://www.cveoy.top/t/topic/hOuj 著作权归作者所有。请勿转载和采集!