标签:常用 样例 value 说明 ApiParam 用于 注解 Swagger 方法
@Api() 用于类 表明此类为swagger资源
value
url的路径值tags
如果设置这个值、value的值会被覆盖
@ApiOperation() 用于方法 说明方法的作用,每个URL资源的定义、
value
方法描述notes
提示内容tags
可重新分组(选用)
@ApiParam() 用于方法、参数、字段说明
name
参数名称value
参数说明required
是否必填example
样例说明
@ApiModel() 用于Post中表单的实体类
value
对象名description
描述
常用于使用通过@RequestBody来提交表单的场景
@ApiModelProperty() 用于方法 、字段 对实体类属性进行说明
value
字段说明name
字段名字dataType
重写属性类型(非必须不用加)required
是否必填example
样例hidden
隐藏
通过该注解,在提交Body
数据时,会提供详细的关于字段的解释以及正确的样例
@ApiImplicitParam() @ApiImplicitParams()
功能和@ApiParam()
,一般情况下使用@ApiParam
即可
标签:常用,样例,value,说明,ApiParam,用于,注解,Swagger,方法 来源: https://blog.csdn.net/m0_52038897/article/details/122737763
本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享; 2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关; 3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关; 4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除; 5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。