在Spring Boot 3中，可以使用springdoc-openapi库来整合Swagger。以下是整合的步骤和示例代码：
- 添加依赖到
pom.xml：
<dependencies>
<!-- SpringDoc OpenAPI -->
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.6.12</version>
</dependency>
</dependencies>
- 配置Swagger：
创建一个配置类来配置Swagger。
import org.springdoc.core.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class SwaggerConfig {
@Bean
public GroupedOpenApi publicApi() {
return GroupedOpenApi.builder()
.group("my-api")
.pathsToMatch("/api/**")
.build();
}
}
- 添加注解到你的Controller类：
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@Tag(name = "Example API", description = "API for example usage")
@RestController
@RequestMapping("/api/example")
public class ExampleController {
@Operation(summary = "Get example data", tags = "Example API")
@GetMapping("/data")
public ResponseEntity<String> getExampleData() {
// ...
return ResponseEntity.ok("Example data");
}
}
- 配置应用的启动类或者
@SpringBootApplication注解的类：
确保启用了Spring Doc的功能。
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class MyApplication {
public static void main(String[] args) {
SpringApplication.run(MyApplication.class, args);
}
}
- 访问Swagger UI：
启动你的Spring Boot应用后，打开浏览器并访问：
http://localhost:8080/swagger-ui.html
或者如果你使用的是Spring Boot 3和SpringDoc 2.x，可能是：
http://localhost:8080/swagger-ui/index.html
以上步骤将会在Spring Boot 3项目中整合Swagger UI，使你能够可视化API和交互。