易配网 - 手机资讯、时事新闻、网络资料 - @apimodelproperty_资讯导航。手机新闻导航
你的位置:易配网 > 手机资讯导航 > 热点 > @apimodelproperty_资讯导航

@apimodelproperty


entity类中用@ApiModelProperty注解什么意思

以下内容均为复制,原文地址:http://blog.csdn.net/u013291972/article/details/72773011

一、swagger常用注解
1、与模型相关的注解
两个注解:
@ApiModel:用在模型类上,对模型类做注释;
@ApiModelProperty:用在属性上,对属性做注释
2、与接口相关的注解
六个注解:
@Api:用在controller上,对controller进行注释;
@ApiOperation:用在API方法上,对该API做注释,说明API的作用;
@ApiImplicitParams:用来包含API的一组参数注解,可以简单的理解为参数注解的集合声明;
@ApiImplicitParam:用在@ApiImplicitParams注解中,也可以单独使用,说明一个请求参数的各个方面,该注解包含的常用选项有:
paramType:参数所放置的地方,包含query、header、path、body以及form,最常用的是前四个。
name:参数名;
dataType:参数类型,可以是基础数据类型,也可以是一个class;
required:参数是否必须传;
value:参数的注释,说明参数的意义;
defaultValue:参数的默认值;
@ApiResponses:通常用来包含接口的一组响应注解,可以简单的理解为响应注解的集合声明;
@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
code:即httpCode,例如400 
message:信息,例如"请求参数没填好"
本文内容来自网络,由 易配网 www.yiper.org整理。
更新时间:2019-12-14 14:53:15