swagger 修改dto注解_Swagger注解及参数细节的正确书写。

本文介绍了在使用Swagger时遇到API无法显示的问题及其解决方法。常见原因包括IDEA缓存和注解错误。对于POST请求,需使用@RequestBody注解配合dataType和paramType。GET请求通常使用@RequestParam。注意请求方法和注解的正确使用,确保在controller和服务层添加适当注解。
摘要由CSDN通过智能技术生成

今天新开了一个api文件,结果怎么搞也在swagger里显示不出来,浪费半天后,去问老员工了。

一般有俩原因,

1.idea缓存,重启idea即可。

2.注解和参数上的修饰有问题,或者请求method不对。

下面说一下在书写上几个需要注意的点。

1.对于无参方法(一般是后端调用的inner方法),一般不会出错。

2.首先区分get请求还是post请求

aababde499d6d264df23eb8ea3cd90be.png

入参是dto对象的都用post请求,即@PostMapping,这样才能解析json格式数据。在参数前面加上 @RequestBody注解,注意dataType要写对应的dto类型,name要与参数名一致。

还要加上这个值 paramType = "body"。

54b131c399239726633eb16b0eb20114.png

注意在controller层中也要加,@RequestParam 不用在controller中加了。

3.对于list<>列表型入参,也需要用 @RequestBody注解修饰,dataType一般是String

9d94b2630815d97801e7dcfa2d9fd15c.png

4.对于get请求,@GetMapping,一般是单个入参,

ac48a20abca3f434f1823002e9b90adb.png

在参数前面加@RequestParam(),其实get请求加@RequestBody还是@RequestParam()都行。

5.最后要在controller和service层impl里加上对应的注解

@RestController和 @Service

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值