Swagger Example Parameter Value

Question

I want to modify the Example Value under the Data Type on my Swagger-ui interface. currently it contains the following default value (generated by Swagger):

"user":{
        "birth":null,
        "nationality":null,
        "lastname":null,
        "firstname":null,
        "identity":null
     }

I want to specify real values instead of the "null" values. PS: I use spring boot with annotations: @ApiOperation,...

Do you mean something like `@ApiParam`? http://docs.swagger.io/swagger-core/current/apidocs/io/swagger/annotations/ApiParam.html — Luciano van der Veekens, Sep 06 '17 at 09:28
When I use the @ApiParam(value="...") I find my example under the description which is not what I want (every other property of @ApiParam shwos nothing) — Chayma Atallah, Sep 06 '17 at 09:43

score 0 · Accepted Answer · answered Apr 03 '18 at 20:44

0

You must then insert @ApiModelProperty anotation for all your attributes inside your bean. Then put an example attribute inside. Let's say your user is mapped to the User.java class, so you would have:

public class User {

    @ApiModelProperty(value = "The birthdate", example = "1985-12-07", format= "yyyy-MM-dd")
    private String birth;

answered Apr 03 '18 at 20:44

A. Masson

2,287
3
30
36

2

what if i want to add a list of examples ?? – dzgeek Dec 25 '18 at 18:59
@dzgeek have a look at https://stackoverflow.com/questions/40989038/swagger-apimodelproperty-example-value-for-liststring-property – A. Masson Dec 26 '18 at 20:45
thank you, but i meant multiple examples for the same entity, not example of a list container, – dzgeek Dec 28 '18 at 07:52

Swagger Example Parameter Value

1 Answers1