How to represent List of Strings in Springdoc Swagger v3?

Question

Below is a code that is similar to the situation I have

@ApiResponses(value = {
            @ApiResponse(responseCode = "200", description = "OK", content = {@Content(schema = @Schema(
                implementation =  // <-- What to specify here?
            ))})
})
@GetMapping(value = "/user")
public ResponseEntity<List<User>> getUsers() {
    return ResponseEntity.ok().body(Arrays.asList(new User(), new User()));
}

How do I specify the list of Users being returned from the endpoint in ApiResponse()?

Please note that the Open-API-Definition is not part of the project, but is specified in another project.

score 11 · Accepted Answer · answered Jul 22 '20 at 14:38

11

Solved using the below method

@ApiResponses(value = {
            @ApiResponse(responseCode = "200", description = "OK", content = {
                @Content(array = @ArraySchema(schema = @Schema(implementation = User.class)))
            })
})
@GetMapping(value = "/user")
public ResponseEntity<List<User>> getUsers() {
    return ResponseEntity.ok().body(Arrays.asList(new User(), new User()));
}

answered Jul 22 '20 at 14:38

Debargha Roy

2,320
1
15
34

Do you know how to add a pattern to the List? I tried to do @Schema(implementation = User.class, pattern = "pattern"), but it doesn't get generated in the swagger documents. – amasuKAKAROT Nov 24 '21 at 15:02
I'm not following what pattern you're referring to. – Debargha Roy Nov 24 '21 at 18:24

How to represent List of Strings in Springdoc Swagger v3?

1 Answers1