Swagger 2 UI如何显示RestController未明确返回的模型

Question

我有一个问题，在Models下大张旗鼓，我只看到抽象基类，该基类被3个其他类扩展。 我当前的端点返回类的基本类型，因为我可以在一个端点上返回3种不同的类型。

所以基本上我有这样的事情

@MappedSuperclass
@ApiModel(description = "Base Details.")
abstract class BaseClass(
    open var id: String? = null,
    var prop1: String? = null,
    var prop2: String? = null,
    var prop3: String? = null,
    var prop4: String? = null
)

@ApiModel(description = "Some Specific Details that contains all base properties.")
data class AnotherClass(
        val prop4: String,
        val prop5: String,
        val prop6: Set<Amount>,
        val prop7: Set<Amount>,
        val prop8: String
) : BaseClass()


@ApiModel(description = "Some more Specific Details that contains all base properties.")
data class OneMoreClass(
        val prop4: String,
        val prop5: String
) : BaseClass()


And in RestController i have this

    @GetMapping
    @ApiOperation(value = "End point description", notes = "Notes notes notes.")
    fun getSomethingFromDatabase(): List<BaseClass> {
        return someService.getData();
    }

所以我遇到的问题是在swagger UI上，在Models部分下，我只看到BaseClass而根本没有其他类。

我尝试了此操作，因为在某个地方我看到了以下示例：

@ApiModel(description = "Base Details.", subTypes = {AnotherClass.class}) 
BaseClass 

但是这样我有“ kotlin”的问题，就是说“名字丢失”，我也不能做AnotherClass :: class ...

Answer 1

您将必须在配置中添加以下内容：

    return new Docket(DocumentationType.SWAGGER_2)
            .additionalModels(typeResolver.resolve(AnotherClass.class), typeResolver.resolve(OneMoreClass.class))
.....

Swagger 2仍不完全支持subTypes ，但仍具有开放票证

对于您的Kotlin配置，应如下所示：

subTypes = [AnotherClass::class, OneMoreClass::class]

我刚刚添加了一个示例Kotlin控制器，供您在我的github 项目中引用。 查找AnimalController.kt和SwaggerConfig以进行所需的设置。