Swagger常用注解实验
2022/1/28 23:04:48
本文主要是介绍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
即可
这篇关于Swagger常用注解实验的文章就介绍到这儿,希望我们推荐的文章对大家有所帮助,也希望大家多多支持为之网!
- 2024-06-03为什么以及如何要进行架构设计权衡?
- 2024-05-31全网首发第二弹!软考2024年5月《软件设计师》真题+解析+答案!(11-20题)
- 2024-05-31全网首发!软考2024年5月《软件设计师》真题+解析+答案!(21-30题)
- 2024-05-30【Java】百万数据excel导出功能如何实现
- 2024-05-30我们小公司,哪像华为一样,用得上IPD(集成产品开发)?
- 2024-05-30java excel上传--poi
- 2024-05-30安装笔记本应用商店的pycharm,再安排pandas等模块,说是没有打包工具?
- 2024-05-29java11新特性
- 2024-05-29哪些无用敏捷指标正在破坏敏捷转型?
- 2024-05-29鸿蒙原生应用再新丁!新华社 入局鸿蒙