swagger-core: ApiModelProperty doesn't support example for arrays / Lists

By default array or List of integers is generated in UI with example:

"eventTypes": [0],

I’ve tried to add “example” property, but that:

@ApiModelProperty(required = true, example = "[2, 3]")
private int[] lorem;

generates example values as string:

"eventTypes": "[2, 3]",

Other options like "2, 3" don’t work neither. In result to have valid json in example it has to have only one value, zero.

About this issue

Original URL
State: closed
Created 8 years ago
Reactions: 53
Comments: 48 (4 by maintainers)

Links to this issue

java - swagger @ApiModelProperty example value for List<String> property - Stack Overflow

Most upvoted comments

it’s work

+13

justforadblock on Dec 4, 2017

This takes a major refactoring of the models, which is on the way.

+13

fehguy on Mar 3, 2017

A working solution:

@ApiModelProperty(value = "Address", name = "addLines", dataType = "List",
    example = "[AddLine1,AddLine2,AddLine3,AddLine4]")

When I render the swagger page, I get the following output:

"addLines": [
      "AddLine1",
      "AddLine2",
      "AddLine3",
      "AddLine4"
    ],

Credit @dane_griffiths https://stackoverflow.com/a/50132642/2245264

+11

biniama on Nov 15, 2018

Will be supported in 3.0.0 support, please see the feature/3.0.0-rc2 branch for details.

fehguy on Jun 27, 2017

@fehguy You closed the issue, but it is not solved! See https://github.com/swagger-api/swagger-core/issues/3863 and see also a lot of comments here.

honza-zidek on Jan 26, 2021

Is there any progress on this issue?

kamaci on Nov 12, 2020

A working solution:
@ApiModelProperty(value = "Address", name = "addLines", dataType = "List",
    example = "[AddLine1,AddLine2,AddLine3,AddLine4]")
When I render the swagger page, I get the following output:
"addLines": [
      "AddLine1",
      "AddLine2",
      "AddLine3",
      "AddLine4"
    ],
Credit @dane_griffiths https://stackoverflow.com/a/50132642/2245264

It doesn’t work for me. Result is “[AddLine1,AddLine2,AddLine3,AddLine4]” , it’s a string,not a list.

ypzhuang on May 17, 2019

Waste a lot of time on this, can’t get it done, and give up finally.

I would suggest migrating to springdoc to get a smooth and intuitive experience

    @Schema(description = "stock codes, in array",
            type = "List",
            example = "[\"TSLA\", \"AAPL\"]")
    private List<String> codes;

liyuntao on Apr 14, 2022

It looks like a lot of people are looking for this feature. This is great. If anyone wants to try and submit a PR to add the functionality, that would be appreciated.

webron on Feb 2, 2017

@biniama, can you please send your swagger version, because i tried the above solution, and it doesn’t work for me.

ghost on Mar 1, 2019