@ApiModel注解的用法

@ApiModel注解是Swagger框架中的一个注解，用于对JavaBean类进行描述。它可以用于描述一个JavaBean类的基本信息，例如名称、描述、版本号等。同时，它还可以定义该类的属性信息，包括每个属性的名称、描述、类型、是否必需等。

@ApiModel注解的常见属性包括：

- value：类的名称；
- description：类的描述；
- parent：该类的父类；
- discriminator：用于区分该类的属性名；
- subTypes：该类的子类；
- reference：是否引用该类；
- properties：该类的属性列表。

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

@ApiModel(value = "用户对象", description = "用户信息描述")
public class User {
    @ApiModelProperty(value = "用户ID", required = true)
    private Long id;
    @ApiModelProperty(value = "用户姓名")
    private String name;
    @ApiModelProperty(value = "用户年龄", required = true)
    private Integer age;
    // 省略getter和setter方法
}

在上面的示例中，@ApiModel注解用于描述User类，其中value属性为“用户对象”，description属性为“用户信息描述”。@ApiModelProperty注解用于描述User类的属性，其中value属性为属性的名称，required属性为是否必需属性。通过使用@ApiModel注解和@ApiModelProperty注解，可以为JavaBean类和其属性提供详细的描述信息，方便生成API文档。