springboot 整合 springfox-boot-starter
时间: 2023-07-08 15:05:28 浏览: 206
springboot 整合
首先,需要在 `pom.xml` 文件中添加以下依赖:
```xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
```
然后,在 Spring Boot 应用的启动类上添加 `@EnableSwagger2` 注解,如下所示:
```java
@SpringBootApplication
@EnableSwagger2
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
```
最后,在控制器类上添加注解来描述 API ,例如:
```java
@RestController
@RequestMapping("/api/v1")
@Api(tags = "用户管理")
public class UserController {
@Autowired
private UserService userService;
@ApiOperation(value = "获取用户信息", notes = "根据用户ID获取用户信息")
@ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
@GetMapping("/users/{id}")
public User getUser(@PathVariable Long id) {
return userService.getUserById(id);
}
}
```
其中,`@Api` 注解用于描述整个 Controller ,`@ApiOperation` 注解用于描述某个具体的方法,`@ApiImplicitParam` 注解用于描述方法参数。
启动应用后,访问 http://localhost:8080/swagger-ui/ 可以看到 Swagger UI 界面,用于测试 API 接口。
阅读全文