CODEWITHSUNDEEP
javaspring-bootswagger-2.0
Donri
Donri

Reputation: 73

How to specify array ([]) type in Swagger

Hi I am trying to autogenerate a class using swagger plugin. One property of this class has to be array, but when I write type: "array" always create a List.

This is part of my "yml" file:

...
probabilities:
        type: "array"
        items:
          type: "number"
          format: "double"
          minimum: 0
          maximum: 1
        description:
          "Vector with probabilities"
        example: [ 0.5, 0.3, 0.1 ]
...

And this is the property that create:

...
 @JsonProperty("probabilities")
 @SerializedName("probabilities")
 private List<Double> probabilities = new ArrayList<Double>();
...

Upvotes: 1

Views: 999

Answers (1)

EPSG31468
EPSG31468

Reputation: 971

In Java, an array has a fixed length. This is different from OpenAPI and JavaScript specifications, where an array can have variable length at runtime. The variable-length equivalent in Java is the List.

The implementation of swagger-codegen for Java converts an array into a java.util.List

Upvotes: 2

Related Questions