1.8.9的功能展示如下图:

    正常情况下,不管是调试还是文档说明都会显示以上字段说明(除非你没写注解说明)

    这里很多朋友碰见的最多的问题主要有2个:

    • 使用泛型T还是不显示

    不显示效果可能如下图:

    Swagger字段属性说明不显示 - 图2

    返回Object不显示字段属性

    返回Map为何不显示

    为何返回Map不显示,大家都知道Map是Java里面的集合接口,不管是Map本身还是诸如HashMap等子实现,这类数据对于Swagger来说都是未定义结构的数据

    Swagger只认识定义好的类-属性,所以接口返回Map,对于Swagger来说是没有字段展示的,这种情况同样适用与返回Object这个顶级父类.这也是为何要适用泛型T的原因

    适用泛型T还是不显示

    很多朋友会说我已经使用泛型T了,可是文档上还是不显示,这里主要的原因有以下几点

    属性定义必须是泛型T,如下:

    返回T类型的get方法必须是返回T,有时候自动生成get、setter方法插件等会将我们的代码生成返回Object,例如:

    最重要的一步,以上步骤完全正确,代码也没有问题,可是ui还是不显示属性,必须在接口层强指定泛型类型(可能是Swagger要求我们写代码要规范吧~~~),如下:

    如果以上情况都ok,还是不显示说明,恭喜你发现了SwaggerBootstrapUi的一个bug,欢迎提反馈给我,我会搞定它的~~!

    另外

    一般在完成以上情况后,字段说明都会显示,这里再提醒一下大家,如果已经在泛型中强制约束了返回类型后,就无需在注解中设置response属性值,比如如下代码

    以上代码返回了泛型Rest类型的List-AlarmResponse集合,但是却注解中加了response属性为AlarmResponse.class,这种情况会造成Ui只显示AlarmReponse类的属性说明,这显然是不对的,因为它把的属性给忽略了,所以:

    一般情况下,是不写注解@ApiOperation中的response属性值,能少写就少写,将剩下的交给springfox-swagger这个框架,由它自动解析生成接口返回类型