Уважаемые, как попросить swagger-ui отобразить оба эндпоинта /api/countries и /api/countries?name=some

Question

Уважаемые, как попросить swagger-ui отобразить оба эндпоинта /api/countries и /api/countries?name=some

- path один, различаются только наличием параметра. В коде контроллера это два метода, но в swagger-ui отображается только один из них.

@RestController
@RequestMapping("/api/countries")
.. class ..

// /api/countries
@io.swagger.annotations.ApiOperation("list all countries")
@GetMapping
public List<Country> findAll() {
return service.findAll();
}

// /api/countries?name=some
@ApiOperation("list countries filtered by name")
@GetMapping(params = "name")
public List<Country> findByName(@RequestParam String name) {
return service.findByName(name);
}

Гуглил всякое типа "swagger separate api by parameters". Пока нагулил только, что swagger так не умеет. Как бы тогда задизайнить?
Можно, конечно, в одном методе и сделать параметр required=false, но так, по-моему, хуже.
Картинко из swagger-ui.

#backend #java #programming #russian

0

23.11.2021

12 ответов

24 просмотра

Sergey Bezrukov

/api/countries/{name} как вариант PathParam или как там его

0

23.11.2021

Cyclone Автор вопроса

Sergey Bezrukov
/api/countries/{name} как вариант PathParam или ка...

Не REST-API'шечно. Я же не одну county по name выбираю.

0

23.11.2021

Sergey Bezrukov

Cyclone
Не REST-API'шечно. Я же не одну county по name выб...

Ну тогда /api/countries/all :-)

0

23.11.2021

Denis Chikanov

Это выглядит, как корявый дизайн апи, почему это разные эндпоинты с точки зрения внешнего пользователя-то?

0

23.11.2021

Sergey Bezrukov

Denis Chikanov
Это выглядит, как корявый дизайн апи, почему это р...

+1

0

23.11.2021

Alexandr ∨∧‾ Emelyanov

Чем это не один метод апи?

0

23.11.2021

Cyclone Автор вопроса

Alexandr ∨∧‾ Emelyanov
Чем это не один метод апи?

По аналогии со спринг датой - findAll без параметров, findByName с параметром name.

0

23.11.2021

Dmitry Boeing

Cyclone
По аналогии со спринг датой - findAll без параметр...

аналогия - не аргумент

0

23.11.2021

Alexandr ∨∧‾ Emelyanov

Cyclone
По аналогии со спринг датой - findAll без параметр...

Не аргумент

0

24.11.2021

Shamil Sabirov

Cyclone
По аналогии со спринг датой - findAll без параметр...

просто findAll без параметров? прям все из базы вытащить? если по аналогии со spring data, то хотя бы Pageable параметр туда передавать нужно в случае со свагерром - хз. я до сих пор на старой версии 2.7.0 свагера сижу. мня устраивает, свои функции выполняет. новый чето не нравиться. возможно вам нужно выбрать какуюто стабильную версию

0

24.11.2021

Islam Yusubov

Shamil Sabirov
просто findAll без параметров? прям все из базы вы...

Просто findAll без параметров Есть и перегрузки с Examaple /Pageable и т д

0

24.11.2021

Torino · Accepted Answer

Torino

Может оба метода на один метод повесить? Не знаю как на это отреагирует сваггер, но спринг справится

0

23.11.2021

170 похожих чатов

Уважаемые, как попросить swagger-ui отобразить оба эндпоинта /api/countries и /api/countries?name=some

12 ответов

Похожие вопросы