【SpringBoot整合系列】SpringBoot3.x整合Swagger
在Spring Boot 3.x中整合Swagger可以通过以下步骤进行:
- 添加Swagger依赖到
pom.xml
文件中:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
- 创建Swagger配置类:
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.OAS_30)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
}
- 在
application.properties
或application.yml
中配置Swagger:
# application.properties
springfox.documentation.enabled=true
springfox.documentation.swagger-ui.enabled=true
springfox.documentation.open-api.v3.path=/v3/api-docs
- 启动Spring Boot应用,并通过访问
http://<host>:<port>/swagger-ui/index.html
来查看Swagger UI界面。
以上步骤可以帮助你在Spring Boot 3.x项目中整合Swagger。如果你的项目中使用了Spring Security,你还需要配置Swagger的安全认证,以免Swagger UI不能正常工作。
评论已关闭