swagger @ApiModel添加实体类不生效的解决

 更新时间:2022年01月10日 14:44:17   作者:caseyfu  
这篇文章主要介绍了swagger @ApiModel添加实体类不生效的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教。

@ApiModel添加实体类不生效 

swagger, @ApiModel, Models, 实体类无法加载

在使用swagger时, 以为加上@ApiModel在实体类上就可以在swagger-ui.html的Models里面显示.

但是我创建了很多实体类, 但怎么也只显示了一个???

Models中无论如何只有User这一个实体类。 后来发现不是加上@ApiModel就可以加入Models中的,必须要在controller层中关联这个实体类。由于我把所有实体类创建好后只测试了User,其它的实体类都没关联,所以swagger-ui.html中的Models没有实体类的显示。

Models实体类无法显示

Swagger环境为:

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

编写实体类 User:

@ApiModel("用户实体类")
public class User {
    @ApiModelProperty("用户名")
    private String username;
    @ApiModelProperty("密码")
    private String password;
}

在controller中使用该实体类:

@PostMapping("/user")
public User user() {
    return new User();
}

却发现Models中根本没有User类的信息!

在这里插入图片描述

解决办法

给实体类添加 get 和 set 方法!

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
@ApiModel("用户实体类")
public class User {
    @ApiModelProperty("用户名")
    private String username;
    @ApiModelProperty("密码")
    private String password;
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }    
}

成功显示!

在这里插入图片描述

由此可知,以后写实体类的时候,写全!

构造方法,get、set方法,toString方法全都加上!

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • 使用Java程序模拟实现新冠病毒传染效果

    使用Java程序模拟实现新冠病毒传染效果

    这篇文章主要介绍了用Java程序模拟实现新冠病毒传染效果,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-08-08
  • springboot响应json null值过滤方式

    springboot响应json null值过滤方式

    这篇文章主要介绍了springboot响应json null值过滤方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11
  • servlet重定向详解(八)

    servlet重定向详解(八)

    这篇文章主要为大家详细介绍了servlet重定向的相关资料,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-09-09
  • Java 在Excel中添加分离型饼图、环形图的方法

    Java 在Excel中添加分离型饼图、环形图的方法

    这篇文章主要介绍了Java 在Excel中添加分离型饼图、环形图的方法,帮助大家更好的理解和使用Java,感兴趣的朋友可以了解下
    2020-12-12
  • Java中的内部类使用详情

    Java中的内部类使用详情

    说起内部类这个词,想必很多人都不陌生,但是又会觉得不熟悉。原因是平时编写代码时可能用到的场景不多,用得最多的是在有事件监听的情况下,并且即使用到也很少去总结内部类的用法。今天我们就来一探究竟
    2022-03-03
  • 一文掌握Spring 中 @Component 和 @Bean 区别(最新推荐)

    一文掌握Spring 中 @Component 和 @Bean 区别(最新推荐)

    ​@Component 用于标识一个普通的类,@Bean用于配置类里面,在方法上面声明和配置 Bean 对象,这篇文章主要介绍了Spring 中 @Component 和 @Bean 区别(最新推荐),需要的朋友可以参考下
    2024-04-04
  • Java小白第一次就能看懂的网络编程

    Java小白第一次就能看懂的网络编程

    网络编程是指编写运行在多个设备(计算机)的程序,这些设备都通过网络连接起来。本文介绍了一些网络编程基础的概念,并用Java来实现TCP和UDP的Socket的编程,来让读者更好的了解其原理
    2021-08-08
  • 高效数据传输的秘密武器Protobuf的使用教程

    高效数据传输的秘密武器Protobuf的使用教程

    Protobuf(Protocol Buffers)是由 Google 开发的一种轻量级、高效的数据交换格式,它被用于结构化数据的序列化、反序列化和传输,本文主要介绍了它的具体使用方法,需要的可以参考一下
    2023-05-05
  • JavaWeb实现邮件发送接收功能

    JavaWeb实现邮件发送接收功能

    这篇文章主要为大家详细介绍了JavaWeb邮件发送接收功能的实现,邮件发送和接收功能是非常常用的功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2015-12-12
  • java绘制国际象棋与中国象棋棋盘

    java绘制国际象棋与中国象棋棋盘

    这篇文章主要为大家详细介绍了java绘制国际象棋与中国象棋棋盘,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-05-05

最新评论