首页天道酬勤apimodelproperty注解在实体类上干嘛的,@Apimodel

apimodelproperty注解在实体类上干嘛的,@Apimodel

admin 08-15 00:57 166次浏览
版本 springfox-swagger2 (version = 2.9.2)swagger-bootstrap-ui (version = 1.9.6)swagger-models (version =1.6.1) @ApiModel

使用场景:在实体类上边使用,标记类时swagger的解析类

属性名称数据类型默认值说明valueString类名为模型提供备用名称descriptionString"提供详细的类描述parentClass<?>Void.class为模型提供父类以允许描述继承关系discriminatorString"支持模型继承和多态,使用鉴别器的字段的名称,可以断言需要使用哪个子类型subTypesClass<?>[]{}从此模型继承的子类型数组referenceString‘’指定对应类型定义和引用,覆盖指定的任何其它元数据@ApiModelProperty

使用场景:使用在被 @ApiModel 注解的模型类的属性上

属性名称数据类型默认值说明valueString"属性简要说明nameString"运行覆盖属性的名称,重写属性名称allowableValuesString"限制参数可接受的值accessString"过滤属性notesString"尚未使用dataTypeString"参数的数据类型requiredbooleanfalse是否必传positionint0允许在模型中排序属性hiddenbooleanfalse隐藏模型属性exampleString"属性的示例值readOnlybooleanfalse指定模型属性为只读,false:非只读referenceString"指定对应类型定义的引用,覆盖指定的任何其他元数据allowEmptyValuebooleanfalse允许传空置,false:不允许传空值
@apimodel注解,swagger返回参数注解 swagger注释API详细说明