Closed
Description
I have a Spring Boot Project with springfox-swagger2 2.7.0 And I have the following controller:
@Api(tags = { "Some" }, description = "CRUD for Some Stuff")
@RestController
@RequestMapping(path = "/some")
public class SomeController {
@ApiOperation(value = "Get some")
@GetMapping(value = "{someId}", produces = MediaType.APPLICATION_JSON_VALUE)
public Response getSomeById(@PathVariable("someId") Id someId) {
return ...;
}
...
}I want to control what is displayed in the docs by annotating the Id class, and this is working only for some parts of the annotation, but not all.
The Id class (which has a registered converter from String to Id):
public class Id {
@ApiParam(value = "This is the description", defaultValue = "1f1f1f", required = true, name = "someId", type = "string")
private final Long id;
public Id(Long id) {
this.id = id;
}
public Long getId() {
return id;
}
}Now the swagger JSON returned looks as follows:
"parameters":[{
"name":"id",
"in":"query",
"description":"This is the description",
"required":true,
"type":"integer",
"default":"1f1f1f",
"format":"int64"
}]My question (or possibly bug report) is: why are some parts of the @ApiParam annotation used (like value, defaultValue and required), but others aren't, like name and type?
Why does it seem like I cannot change the name or type here?
For my particular use case, the latter is the one I would want to change to 'string'.