swagger-请求参数为对象的解决方式

本文详细介绍了如何在Swagger中为请求参数添加注释,包括使用@ApiModel和@ApiModelProperty注解来描述对象及其字段,以及如何使用@RequestBody和@ModelAttribute接收参数。同时,还解释了如何通过@JsonIgnore隐藏特定字段。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

如果请求参数为某个对象,还需要在swagger里显示出注释

第一步:在对象的类上加注解@ApiModel,类的字段上加注解@ApiModelProperty(value = "id或者姓名等注释")

第二步:controller类里直接使用@RequestBody OrderModel orderModel,json接收(如果是想表单提交,则用@ModelAttribute OrderModel orderModel)

第三步(可选):如果不想展示某些字段在swagger上,需要在字段上加上@JsonIgnore注解

最后得到的结果:

 

可能出现的问题:

如果你在controller里加了@ApiImplicitParams({ @ApiImplicitParam(name = "OrderModel")})

注意,一、name的值如果你填“OrderModel”,会出现两个框

          二、name的值如果你填了"orderModel"小写开头或者其他内容,将不会出现字段注释


 

 

评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值