生成一个Swagger的实体类和controller
时间: 2024-03-13 07:45:08 浏览: 23
好的,生成Swagger的实体类和controller的过程如下:
1. 首先需要在项目的pom.xml文件中添加Swagger的依赖,如下所示:
```
<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>
```
2. 在Spring Boot的启动类上添加@EnableSwagger2注解,启用Swagger:
```
@SpringBootApplication
@EnableSwagger2
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
```
3. 创建实体类,并使用Swagger的注解来描述实体类:
```
@ApiModel(description = "用户信息")
public class User {
@ApiModelProperty(value = "用户ID", example = "1")
private Long id;
@ApiModelProperty(value = "用户名", example = "张三")
private String name;
@ApiModelProperty(value = "年龄", example = "18")
private Integer age;
// 省略getter和setter方法
}
```
4. 创建控制器,并使用Swagger的注解来描述控制器和接口:
```
@RestController
@RequestMapping("/users")
@Api(tags = "用户管理")
public class UserController {
@PostMapping("")
@ApiOperation(value = "创建用户")
public User createUser(@RequestBody @ApiParam(value = "用户信息") User user) {
// 创建用户的逻辑
}
@GetMapping("/{id}")
@ApiOperation(value = "查询用户")
public User getUser(@PathVariable Long id) {
// 查询用户的逻辑
}
// 省略其它接口
}
```
5. 启动项目,并访问http://localhost:8080/swagger-ui.html,即可看到Swagger的UI界面,可以通过界面来测试接口。
以上就是生成Swagger的实体类和controller的过程,希望能帮到你。