Swagger @ApiModel 注解的作用和示例

Swagger @ApiModel 注解是用于描述一个 Java 类（DTO，实体类等）的作用和属性信息，是 Swagger UI 显示 API 文档时的基础信息之一。

使用 @ApiModel 注解可以为 Java 类指定一个名称、一个描述信息、一个子类等信息。在 Swagger UI 中，使用 @ApiModel 注解可以帮助我们更清晰地了解每个 API 方法所接收和返回的参数的数据结构和数据类型。

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

@ApiModel(description = "用户信息实体类")
public class User {

    @ApiModelProperty(value = "用户 ID", example = "123")
    private Long id;

    @ApiModelProperty(value = "用户名", example = "John")
    private String name;

    @ApiModelProperty(value = "用户年龄", example = "18")
    private Integer age;

    // getter and setter methods
}

在这个示例中，@ApiModel 注解指定了用户信息实体类的描述信息，即“用户信息实体类”。在 User 类的属性上，我们还使用了 @ApiModelProperty 注解，指定了每个属性的名称、描述信息、数据类型和示例值。在 Swagger UI 中，我们可以看到 User 类的详细信息，包括每个属性的名称、数据类型、描述信息和示例值。