Swagger字段属性说明不显示

墨蓝 2023-02-18 03:25 8阅读 0赞

# 楔子 #

> 学习记录笔记。Swagger字段属性说明不显示问题

## 问题 ##

返回单个bean就显示 字段说明  
返回 map 就不显示字段说明  
![Swagger字段属性说明不显示][Swagger]

## [解决][Link 1] ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI4NDg3MDk_size_16_color_FFFFFF_t_70]

返回字段使用泛型 ，并且返回方法 返回泛型  
例如controller 方法

@GetMapping("localpermapList")
    @ApiOperation("localswagger测试MapList")
    public R<List<Person>> personrDataList() {
        
        ArrayList<Person> list = new ArrayList<>();
        for (int i = 0; i < 10; i++) {
        
            list.add(new Person().setAge(i).setName("测试" + 1).setBirthday(new Date()));
    
        }
        return R.ok().result(list)
                .data("name", "测试")
                .dataBean("dataBean", list);
    }
    
    
    @GetMapping("localpermapList")
    @ApiOperation("localswagger测试MapList")
    public R<Person> personrData() {
        
        
            Person p= new Person().setAge(i).setName("测试" ); 
        return R.ok().result(p)
                .data("name", "测试")
                .dataBean("dataBean", p);
    }

详见 `com.study.web.RedisController`  
[码云位置 https://gitee.com/demo51/spredis][https_gitee.com_demo51_spredis]

[Swagger]: https://img-blog.csdnimg.cn/20200615224142919.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI4NDg3MDk=,size_16,color_FFFFFF,t_70
[Link 1]: https://www.bookstack.cn/read/swagger-bootstrap-ui/40.md#Swagger%E5%AD%97%E6%AE%B5%E5%B1%9E%E6%80%A7%E8%AF%B4%E6%98%8E%E4%B8%8D%E6%98%BE%E7%A4%BA
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI4NDg3MDk_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200615224413741.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI4NDg3MDk=,size_16,color_FFFFFF,t_70
[https_gitee.com_demo51_spredis]: https://gitee.com/demo51/spredis