swagger2注解

Swagger2是一个用于生成RESTful API文档的框架，它可以根据代码自动生成API文档，方便开发者进行API测试和调用。下面是Swagger2注解的介绍和演示：

1.@Api：用于类上，表示该类是Swagger2的资源。

2.@ApiOperation：用于方法上，表示一个HTTP请求的操作。

3.@ApiParam：用于参数上，用来描述参数。

4.@ApiModel：用于类上，表示对类进行说明，用于参数用实体类接收的情况。

5.@ApiModelProperty：用于属性上，描述响应类的属性。

6.@ApiIgnore：用于类或者方法上，表示该类或方法不会被Swagger2处理。

下面是一个使用Swagger2注解的示例：

@RestController
@Api(tags = "用户管理")
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    @ApiOperation(value = "获取用户列表", notes = "获取所有用户列表")
    @GetMapping("/list")
    public List<User> list() {
        return userService.list();
    }

    @ApiOperation(value = "添加用户", notes = "添加一个新用户")
    @PostMapping("/add")
    public String add(@ApiParam(name = "user", value = "用户信息", required = true) @RequestBody User user) {
        userService.add(user);
        return "success";
    }

    @ApiOperation(value = "更新用户", notes = "根据用户ID更新用户信息")
    @PutMapping("/update/{id}")
    public String update(@ApiParam(name = "id", value = "用户ID", required = true) @PathVariable Long id,
                         @ApiParam(name = "user", value = "用户信息", required = true) @RequestBody User user) {
        userService.update(id, user);
        return "success";
    }

    @ApiOperation(value = "删除用户", notes = "根据用户ID删除用户")
    @DeleteMapping("/delete/{id}")
    public String delete(@ApiParam(name = "id", value = "用户ID", required = true) @PathVariable Long id) {
        userService.delete(id);
        return "success";
    }
}