springboot + swagger的实体类属性注解
2024-10-19 11:52:18
@Api：用在类上，说明该类的作用
@ApiOperation：用在方法上，说明方法的作用
@ApiImplicitParams：用在方法上包含一组参数说明
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
paramType：参数放在哪个地方
header-->请求参数的获取：@RequestHeader
query-->请求参数的获取：@RequestParam
path（用于restful接口）-->请求参数的获取：@PathVariable
body（不常用）
form（不常用）
name：参数名
dataType：参数类型
required：参数是否必须传
value：参数的意思
defaultValue：参数的默认值
@ApiResponses：用于表示一组响应
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
code：数字，例如400
message：信息，例如"请求参数没填好"
response：抛出异常的类
@ApiModel：描述一个Model的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）
@ApiModelProperty：描述一个model的属性
具体其他的注解，查看：
https://github.com/swagger-api/swagger-core/wiki/Annotations#apimodel
最新文章
- OpenSSL主配置文件openssl.cnf
- Match:DNA repair(POJ 3691)
- 抓包软件PowerSniff开发计划
- NOIP201302表达式求值
- OpenJudge计算概论-字符串排序
- CentOS 下如何查看并清理系统内存空间
- [JS 基础] touchEvent中的changedTouches，targetTouches和touches的区别
- 让图片在DIV中垂直居中
- 多态性Polymorphism
- std::function 测试
- MVC分页控件的使用
- idea中的汉语注释出现乱码的解决方案
- C语言博客作业—一二维数组
- Java相关错误
- 关于ApiCloud的Superwebview在androidstudio中集成微信支付模块，提示模块未绑定的问题
- Mac上配置maven+eclipse+spark开发环境
- Django 中的Form表单认证
- c# 界面自适应大小
- 为chrome设置代理
- English Voice of <<All Of Me>>