Docket.ignoredParameterTypes() removes classes completly

[thomseno]

Just migrated our project from swagger-springmvc to springfox 2.1.2 and recognized, that my ignoredParameterTypes are missing completely in swagger:
swagger-springmvc:


springfox:


SwaggerConfig:
Just ignoring org.joda.time classes

        return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(new ApiInfo("IBS", "REST services", apiVersion, null, null, null, null))
            .ignoredParameterTypes(DateTime.class)
            .ignoredParameterTypes(LocalDate.class)
            .ignoredParameterTypes(LocalTime.class)
            .ignoredParameterTypes(LocalDateTime.class)
            .pathMapping("/api/v1")
            .groupName("1_rest")
            .select()
            .paths(ibsRestPaths())
            .build();

[dilipkrish]

@thomseno that was a bug unfortunately. the right way to hide properties is to either use an annotation to mark it as such @ApiModelProperty(hidden=true) to hide specific properties. Or if you're only hiding it cos' its generating deep models you don't care about consider using the docket.directModelSubstitute(LocalDate.class, String.class)

[thomseno]

Hi @dilipkrish thanks for the answer. The intention was to prevent generation of deep models. But if I use docket.directModelSubstitute(LocalDate.class, String.class) the original type of the field (LocalDate) will not be visible anymore, because something like this will be generated:

{
    "printId": "string",
    "printDate": "string"
}

So if I have something like this

{
    "validFrom": "string",
    "validTo": "string"
}

it's hard to decide what input the service expects (LocalDate or LocalDateTime). So how do I handle this?

[dilipkrish]

@thomseno that could go in the description via @ApiModelProperty#notes

[cbornet]

@thomseno You can use this:

docket
.directModelSubstitute(LocalDate.class, java.sql.Date.class)
.directModelSubstitute(LocalDateTime.class, java.util.Date.class)

You will get

                "localdate":
                {
                    "type": "string",
                    "format": "date"
                },
                "localdatetime":
                {
                    "type": "string",
                    "format": "date-time"
                },