Как комментировать ответ массива объектов в Swagger

Question

Мне нужно отладить проект REST API Java, который был разработан с использованием Swagger. Я новичок в этом, поэтому я немного запутался в том, как делать определенные вещи. Например, вот один метод:

@GET
@Path("/location/name")
@Produces({MediaType.APPLICATION_JSON})
@Operation(
    summary = "Get location information",
    tags = {"Information"},
    responses = {
        @ApiResponse(responseCode = "200", content = @Content(schema = @Schema(implementation = LocationResponse.class)), description = "Get location information"),
        @ApiResponse(responseCode = "500", description = "Error: Internal Server Error")
    }
)
public Response searchLocationByName(
    @Parameter(description = "Location name", required = true) @DefaultValue("Barcelona") @QueryParam("name") String locationName
) { /* METHOD CODE */ }

@ApiResponse для кода 200 относится не к типу LocationResponse, а к типу ArraList<LocationResponse>, поскольку он может возвращать более одного местоположения. Какой будет правильный синтаксис для этого изменения? Я читал документацию по https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Annotations#operation -аннотации , но не смог найти подходящий пример ...

Спасибо!

Answer 1

Используйте @ArraySchema вместо обычного @Schema до для определения входных или выходных данных для типов массивов .