第1步:标注实体类的字段 @ApiModel("ReportPage") @Data @TableName("report_page") publicclassReportPage{ @ApiModelProperty("报表id") //报表类型id @TableId(value="page_id",type=IdType.AUTO) privateIntegerpageId; @ApiModelProperty("报表名称") privateStringpageName; ... } 1. 2. 3. 4. 5...
使用方式,在不需要递归展开的属性上加上IgnoreSwaggerParameter注解 package com.example.model.po; import com.example.annotation.IgnoreSwaggerParameter; import com.example.model.BaseModel; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.sql...
notes String "" 属性的注释 position int 0 属性的位置 实践案例 假设我们有一个用户管理系统,需要设计一个用户模型,并使用 Swagger 注解@ApiModel 和@ApiModelProperty 对其进行描述。以下是更详细的示例代码: import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; @ApiModel(value...
@ApiModel(value="user对象",description="用户对象user") publicclassUser implements Serializable{ privatestaticfinallongserialVersionUID = 1L; @ApiModelProperty(value="用户名",name="username",example="xingguo") privateString username; @ApiModelProperty(value="状态",name="state",required=true) privateInt...
{privatestaticfinal long serialVersionUID=1L;@Getter@Setter@ApiModelProperty(value="返回标记:成功标记=0,失败标记=1")privateint code;@Getter@Setter@ApiModelProperty(value="返回信息")privateString msg;@Getter@Setter@ApiModelProperty(value="数据")privateTdata;publicstatic<T>R<T>ok(){returnrestResult...
参数实体:User java @ApiModel(value = "用户实体类")@DatapublicclassUser{@ApiModelProperty(value = "用户名")publicString userName;@ApiModelProperty(value = "密码")publicString password;@ApiModelProperty(value = "照片")publicMultipartFile file; } ...
@ApiModelProperty(value = "数字枚举", notes = "com.xxx.enums.NumEnum ") private NumEnum num; } 1. 2. 3. 4. 5. 6. 7. 此时,所有步骤已完成,当controller返回这个包含自定义注解enum的vo时,前端swagger显示对应的参数说明如下(可用值是自动生成的,可用属性allowableValues自定义):...
@ApiModelProperty:描述一个model的属性 ApiParam:使用在参数上(和ApiImplicitParam使用其一即可) name属性名称 value属性值 defaultValue默认属性值 allowableValues可以不配置 required是否属性必填 access allowMultiple默认为false hidden隐藏该属性
@ApiModel(value="用户",description="用户实体")publicclassUser{@ApiModelProperty(value="主键")privateInteger id;@ApiModelProperty(value="用户名称")privateString name;@ApiModelProperty(value="用户年龄",notes="年龄的值需要符合实际1~200")privateInteger age;} ...