快捷導(dǎo)航

swagger?@ApiModel添加實(shí)體類不生效的解決

更新時(shí)間：2022年01月10日 14:44:17 作者：caseyfu

這篇文章主要介紹了swagger?@ApiModel添加實(shí)體類不生效的解決方案，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教。

@ApiModel添加實(shí)體類不生效

swagger, @ApiModel, Models, 實(shí)體類無(wú)法加載

在使用swagger時(shí), 以為加上@ApiModel在實(shí)體類上就可以在swagger-ui.html的Models里面顯示.

但是我創(chuàng)建了很多實(shí)體類, 但怎么也只顯示了一個(gè)？？？

Models中無(wú)論如何只有User這一個(gè)實(shí)體類。后來(lái)發(fā)現(xiàn)不是加上@ApiModel就可以加入Models中的，必須要在controller層中關(guān)聯(lián)這個(gè)實(shí)體類。由于我把所有實(shí)體類創(chuàng)建好后只測(cè)試了User，其它的實(shí)體類都沒(méi)關(guān)聯(lián)，所以swagger-ui.html中的Models沒(méi)有實(shí)體類的顯示。

Models實(shí)體類無(wú)法顯示

Swagger環(huán)境為：

<!-- 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>

編寫(xiě)實(shí)體類 User：

@ApiModel("用戶實(shí)體類")
public class User {
? ? @ApiModelProperty("用戶名")
? ? private String username;
? ? @ApiModelProperty("密碼")
? ? private String password;
}

在controller中使用該實(shí)體類：

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

卻發(fā)現(xiàn)Models中根本沒(méi)有User類的信息！

在這里插入圖片描述

解決辦法

給實(shí)體類添加 get 和 set 方法！

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
@ApiModel("用戶實(shí)體類")
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;
    }    
}

成功顯示！

在這里插入圖片描述