Как аннотировать ответ массива объектов в Swagger ⇐ JAVA
-
Anonymous
Как аннотировать ответ массива объектов в Swagger
Мне нужно отладить Java-проект REST API, разработанный с использованием Swagger. Я новичок в этом деле, поэтому немного не понимаю, как делать определенные вещи. Например, вот один из способов:
@GET @Path("/местоположение/имя") @Produces({MediaType.APPLICATION_JSON}) @Операция( summary = "Получить информацию о местоположении", теги = {"Информация"}, ответы = { @ApiResponse(responseCode = "200", content = @Content(schema = @Schema(implementation = LocationResponse.class)),description = "Получить информацию о местоположении"), @ApiResponse(responseCode = «500», описание = «Ошибка: внутренняя ошибка сервера») } ) публичный ответ searchLocationByName( @Parameter(description = «Название местоположения», обязательно = true) @DefaultValue («Барселона») @QueryParam («имя») String locationName ) { /* КОД МЕТОДА */ } @ApiResponse для кода 200 имеет не тип LocationResponse, а тип ArrayList, поскольку он может возвращать более одно место. Каков будет правильный синтаксис для этого изменения? Я читал документацию по адресу https://github.com/swagger-api/swagger- ... nnotations, но не смог найти подходящего примера. .
Спасибо!
Мне нужно отладить Java-проект REST API, разработанный с использованием Swagger. Я новичок в этом деле, поэтому немного не понимаю, как делать определенные вещи. Например, вот один из способов:
@GET @Path("/местоположение/имя") @Produces({MediaType.APPLICATION_JSON}) @Операция( summary = "Получить информацию о местоположении", теги = {"Информация"}, ответы = { @ApiResponse(responseCode = "200", content = @Content(schema = @Schema(implementation = LocationResponse.class)),description = "Получить информацию о местоположении"), @ApiResponse(responseCode = «500», описание = «Ошибка: внутренняя ошибка сервера») } ) публичный ответ searchLocationByName( @Parameter(description = «Название местоположения», обязательно = true) @DefaultValue («Барселона») @QueryParam («имя») String locationName ) { /* КОД МЕТОДА */ } @ApiResponse для кода 200 имеет не тип LocationResponse, а тип ArrayList, поскольку он может возвращать более одно место. Каков будет правильный синтаксис для этого изменения? Я читал документацию по адресу https://github.com/swagger-api/swagger- ... nnotations, но не смог найти подходящего примера. .
Спасибо!
Мобильная версия