Swagger注解及参数细节的正确书写。
今天新开了一个api文件,结果怎么搞也在swagger里显示不出来,浪费半天后,去问老员工了。
一般有俩原因,
1.idea缓存,重启idea即可。
2.注解和参数上的修饰有问题,或者请求method不对。
下面说一下在书写上几个需要注意的点。
1.对于无参方法(一般是后端调用的inner方法),一般不会出错。
2.首先区分get请求还是post请求
入参是dto对象的都用post请求,即@PostMapping,这样才能解析json格式数据。在参数前面加上 @RequestBody注解,注意dataType要写对应的dto类型,name要与参数名一致。
还要加上这个值 paramType = "body"。
注意在controller层中也要加,@RequestParam 不用在controller中加了。
3.对于list<>列表型入参,也需要用 @RequestBody注解修饰,dataType一般是String
4.对于get请求,@GetMapping,一般是单个入参,
在参数前面加@RequestParam(),其实get请求加@RequestBody还是@RequestParam()都行。
5.最后要在controller和service层impl里加上对应的注解
@RestController和 @Service
下班记得打卡