Define custom formats with ApiModelProperty and ApiParam

• What version of the library are you using? 2.8.0

What kind of issue is this?

• Question. Is this a question about how to do a certain thing? - Yes

We are trying to specify format in ApiParam. We see that it supports the field. When swagger is generated, the format field is not present.

@ApiParam(
    value = "Example: 12345678-1234-1234-1234-123456789012", 
    required = true, 
    allowEmptyValue = false, 
    format = "testFormat")
@Size(min=36, max=36)
@RequestParam(value = "correlationID") String correlationID)

generates

{
    name: "correlationID",
    in: "query",
    description: "Example: 12345678-1234-1234-1234-123456789012",
    required: true,
    type: "string",
    maximum: 36,
    minimum: 36,
}

We also want to add custom formats to ApiModelProperty, but it does not appear to support the format field. Is that a potential feature that can be added, or is there a work-around for this?

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[Rajan2212]

How to add below lines in the json file using swagger annotation ? which annotation should be used ?

{ “type”: “string”, “format”: “password” }

I am not able to get proper answer till now…is only by manual way we can achieved this ?