We Are Going To Discuss About swagger @ApiModelProperty example value for List
swagger @ApiModelProperty example value for List property
- swagger @ApiModelProperty example value for List
property I've been working with Swagger for almost two months now and as our project progressed issues like this showed up. Now I did some research and read on the GitHub pages for the Swagger-API that this feature simply doesn't work (yet).
- swagger @ApiModelProperty example value for List
property I've been working with Swagger for almost two months now and as our project progressed issues like this showed up. Now I did some research and read on the GitHub pages for the Swagger-API that this feature simply doesn't work (yet).
Solution 1
I managed to get this to work, generating a List of Strings.
Within the ApiModelProperty with springfox 2, write your example as follows:
example = "[\"AddLine1\",\"AddLine2\",\"AddLine3\",\"AddLine4\"]"
Here is my example:
@ApiModelProperty(value = "Address", name = "addLines",
example = "[\"AddLine1\",\"AddLine2\",\"AddLine3\",\"AddLine4\"]")
When I render the swagger page, I get the following output:
"addLines": [
"AddLine1",
"AddLine2",
"AddLine3",
"AddLine4"
],
Original Author dane_griffiths Of This Content
Solution 2
TLDR: One of the contributers on Swagger-API has worked on this functionality to add this in version 3.0.0 but it’s not sure yet when this will be released. For now it stands on the feature/3.0.0-rc2 branch at the Swagger-API GitHub
I’ve been working with Swagger for almost two months now and as our project progressed issues like this showed up. Now I did some research and read on the GitHub pages for the Swagger-API that this feature simply doesn’t work (yet).
As described here and [here would be an other link but my reputation is not high enough to post more than 2 links] this feature has been requested several times since August 2015 with not much luck.
Now on this issue on the Swagger-API github, one of the contributors commented:
This takes a major refactoring of the models, which is on the way. 3 March 2017
which lead to a later comment:
Will be supported in 3.0.0 support, please see the feature/3.0.0-rc2 branch for details. 27 June 2017
And on 9 August 2017 someone asked when the release of version 3.0.0 would be with no further response.
So in conclusion, support for examples for arrays/Lists has been worked on and should be available in version 3.0.0 but no more news on when that would be released.
Original Author KoenC Of This Content
Solution 3
You just use Reflection
notation. Using
@ApiModelProperty(dataType = "[Ljava.lang.String;")
works fine, but I can’t put examples.
This is the result:
{
"field": [
"string"
]
}
Original Author Daniel Borges Of This Content
Solution 4
Try to initialize @ApiModelProperty
as follows:
public class MyClass {
....
@ApiModelProperty(
position = 2, datatype="List", example = "PRD1, PRD2, PRD3"
)
private List<String> productIdentifiers;
....
}
Original Author Zeeshan Arif Of This Content
Conclusion
So This is all About This Tutorial. Hope This Tutorial Helped You. Thank You.