swagger2-2.9.2使用过程中遇到的坑:

异常信息:Could not resolve reference because of :Could not resolve pointer:/definitions/pdo/UserDo does not exist in document.

真心实意的讲一句,对于IT这块,网上资料全面而又复杂,其中难免会有不符的事实,需要咱们自己去尝试不能一味的去啃别人啃过的饼,很浪费时间的!!!。

回归正题,我在使用swagger2生成项目的API的时候,由于我们所有的post请求都是经过自己处理去拿到请求体(请求体类型是实体类),经过我的调查和验证证明swagger传递实体类参数方式两种方法可行:①使用@RequestBody注解;②:使用@ApiImplicitParam注解,设置其paramType 取值为body,前面讲了我们取请求体的方式是通过读取请求体的流然后转换为dto,所以只能采取第二种方式,此次遇到的坑就是在此处。

@ApiImplicitParam注解使用如下:

@ApiImplicitParam(name = "UserDo", value = "用户实体", paramType = "body", dataTypeClass = UserDo.class, required = true)

重点是上面标红处,说明一下,我踩的坑就是name属性的设置,参照网上的设置此处全是实体类的小写形式,所以我就照搬,结果遇到的异常就是上面的文档不存在,此处,!大家一定要写实体类的名字,必须一致!!!其次就是dataTypeClass属性,这个估计第一次看到,当你点进去@ApiImplicitParam源码的时候就可以看到这个属性的说明,如果设置那么它的优先权比dataType属性要高,所以此处采用这个属性来设置,推荐大家使用,最后希望大家在查阅资料的时候可以明鉴真假,减少个人时间的浪费!

你可能感兴趣的:(SpringBoot)