使用继承时的Spring Boot Swagger复制模型类型

问题描述

我有一个使用Spring Boot和Swagger的Java项目。该项目包含一个实现单个端点的简单API控制器。在端点上调用GET方法可获取所有用户。在同一端点上调用PUT方法将更新一个用户：

@RestController
@RequestMapping("/api/v1/users")
public class UserController {
    @RequestMapping(value = "",method = RequestMethod.GET)
    public List<BaseUser> getUsers(String name) {
        return null;
    }

    @RequestMapping(value = "",method = RequestMethod.PUT)
    public BaseUser updateUser(@RequestBody BaseUser user) {
        return null;
    }
}

/api/v1/users终结点是使用BaseUser实现的，该子类型具有EmployeeUser：

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME,property = "type")
@JsonSubTypes({
        @JsonSubTypes.Type(value = EmployeeUser.class,name = "employee")
})
public abstract class BaseUser {

    private final int id;
    private final String name;

    @JsonCreator
    protected BaseUser(
            @JsonProperty("id") int id,@JsonProperty("name") String name) {
        this.id = id;
        this.name = name;
    }

    public int getId() {
        return id;
    }

    public String getName() {
        return name;
    }
}

public class EmployeeUser extends BaseUser {
    public EmployeeUser(@JsonProperty("id") int id,@JsonProperty("name") String name) {
        super(id,name);
    }
}

使用这种结构，当我浏览Swagger UI时，我看到这些模型类型的重复项（基于OpenAPI规范中的定义）。

我希望只能看到一个BaseUser和一个EmployeeUser。重复的原因是什么？

OpenAPI规范中的定义：

"definitions": {
    "BaseUserReq": {
        "type": "object","discriminator": "type","properties": {
            "id": {
                "type": "integer","format": "int32"
            },"name": {
                "type": "string"
            }
        },"title": "BaseUserReq"
    },"BaseUserRes": {
        "type": "object","title": "BaseUserRes"
    },"EmployeeUserReq": {
        "title": "EmployeeUser","allOf": [{
            "$ref": "#/definitions/BaseUserReq"
        },{
            "type": "object","properties": {
                "id": {
                    "type": "integer","format": "int32"
                },"name": {
                    "type": "string"
                }
            },"title": "EmployeeUserReq"
        }]
    },"EmployeeUserRes": {
        "title": "EmployeeUser","allOf": [{
            "$ref": "#/definitions/BaseUserRes"
        },"title": "EmployeeUserRes"
        }]
    }
}

解决方法

我在3.0.0版中遇到了类似的问题，因此我仍在项目中使用2.9.2。您可以尝试以下方法。

将测试项目中的依赖项（已删除springfox-bean-validators，springfox-boot-starter）更改为：

<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.9.2</version>
</dependency>
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.9.2</version>
</dependency>

...并将SwaggerConfig更改为（更改依赖项后删除丢失的导入）为：

@Configuration
@EnableSwagger2
public class SwaggerConfig { }

... http://localhost:8080/swagger-ui.html处的Swagger UI端点将返回您期望的类：

---

此外，您可以删除spring-core依赖项，因为它已经打包在spring-boot-starter-web，maven-compiler-plugin依赖项中，因为它是一个插件，并删除了重复的maven编译器源和目标定义定义为属性，第二次定义为Maven编译器插件的配置。

,

生成BaseUserReq，BaseUserRes，EmployeeUserReq和EmployeeUserRes是因为默认情况下Springfox 3.0使用Swagger v3模型。您可以在application.properties中禁用它。

Springfox 3.0默认使用v3模型。要暂时解决此问题， 在您的计算机中添加： springfox.documentation.swagger.v2.use-model-v3 = false application.properties。 来自https://github.com/springfox/springfox/issues/3503#issuecomment-684819445

禁用springfox v3模型后，我得到了：

此处Suffix with number like "_1" is added to duplicated object name

对此问题进行了描述

嗨，@ pitzcarraldo。感谢您的举报。

上次更改的意图已经合并到母版中，并且 在3.0.0-SNAPSHOT版本中可用的型号与 不对称的特性。因此，如果模型具有不同的属性 序列化和反序列化 SpringFox将生成两个模型。 “ ModelName”用于序列化，“ ModelName_1”用于反序列化或 反之亦然。 来自https://github.com/springfox/springfox/issues/3014#issuecomment-497941639

我通过删除@JsonCreator和@JsonProperty构造函数中的BaseUser和EmployeeUser来解决了这个问题

从springfox 3.0.0开始，swagger网址为http://localhost:8080/swagger-ui/

请参阅github存储库https://github.com/ielatif/swagger-test

提交历史记录以进行解释https://github.com/ielatif/swagger-test/commits/master