Swagger @ApiModelProperty 注解的作用和示例

Swagger 的 @ApiModelProperty 注解用于描述实体类的属性,为 Swagger UI 页面生成对应的 API 文档,包括属性名、类型、是否必填、默认值、描述等信息。

作用:

描述实体类的属性信息,为 API 文档生成提供必要的信息。
支持设置属性的名称、描述、是否必填、默认值等属性信息。


示例:

@ApiModel("用户实体类")
public class User {

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

    @ApiModelProperty(value = "用户名称", required = true, example = "张三")
    private String name;

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

    // 省略 getter 和 setter 方法
}

在上面的示例中,我们使用了 @ApiModelProperty 注解来描述 User 实体类的属性信息。其中,value 属性用于设置属性的描述信息,example 属性用于设置属性的默认值,required 属性用于标识该属性是否必填。在 Swagger UI 页面中,属性名称、类型、描述信息、是否必填、默认值等信息都会被显示出来。