Swagger @ApiParam 注解的作用和示例

Swagger @ApiParam 注解用于描述一个参数，它可以应用在方法的参数上，用于标识参数的信息，比如参数名、数据类型、默认值、描述等，让API文档更加清晰明了。下面是一个示例：

@PostMapping("/user")
@ApiOperation("创建用户")
public User createUser(@ApiParam(value = "用户名", required = true) @RequestParam String username,
                       @ApiParam(value = "密码") @RequestParam(required = false) String password) {
    User user = new User();
    user.setUsername(username);
    user.setPassword(password);
    return userRepository.save(user);
}

在上面的示例中，我们使用 @ApiParam 注解来描述两个参数：username 和 password。其中，value 属性用于描述参数的名称和作用，required 属性用于标识参数是否必填，默认为 false。

生成的API文档中将显示这些参数的信息，帮助客户端更好地理解和使用API。