springboot3整合swagger
时间: 2023-10-31 08:05:12 浏览: 143
好的,针对您的问题,我可以给出以下步骤:
1. 在 pom.xml 文件中添加 Swagger2 和 Swagger UI 的依赖:
```xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>3.0.0</version>
</dependency>
```
2. 创建 Swagger 配置类,用于配置 Swagger 的基本信息和扫描的包路径:
```java
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
.paths(PathSelectors.any())
.build()
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Spring Boot 3 整合 Swagger")
.description("使用 Swagger 构建 API 文档")
.version("1.0.0")
.build();
}
}
```
3. 在 Controller 类中添加 Swagger 注解,用于描述接口信息:
```java
@RestController
@RequestMapping("/user")
@Api(tags = "用户管理")
public class UserController {
@GetMapping("/{id}")
@ApiOperation(value = "根据 ID 获取用户信息", notes = "根据传入的 ID 参数获取用户信息")
@ApiImplicitParam(name = "id", value = "用户 ID", required = true, dataType = "Long", paramType = "path")
public User getUserById(@PathVariable Long id) {
// 根据 ID 查询用户信息
return userService.getUserById(id);
}
// 其他接口方法...
}
```
4. 启动应用程序,访问 http://localhost:8080/swagger-ui.html 即可查看生成的 API 文档。
阅读全文