Реализовывать поиск в Swagger UI

Question

У меня возник вопрос о реализации поиска в моем пользовательском интерфейсе Swagger, который использует localhost.

Я искал в Интернете, и я не нашел ответа на это.

Мой вопрос: «Возможно ли реализовать поиск в пользовательском интерфейсе Swagger, чтобы люди могли искать путь к API?»

Заранее благодарен!

Answer 1

Я получил ответ на официальной странице сообщества Swagger в Googlegroups.

Они предложили следующую страницу на github, и это было именно то, что я искал. Это очень приятная поисковая реализация в пользовательском интерфейсе Swagger.

https://github.com/swagger-api/swagger-ui/pull/2116

В любом случае спасибо за ответ на мой вопрос!

Answer 2

У этого swagger-ui пока нет опции поиска ui. Но в качестве решения у вас есть 2 варианта.

1. По умолчанию swagger-ui перечислит набор apis на основе путей (аннотируется @Api() в коде api). В приведенном ниже примере он перечислил вниз apis на основе двух путей (цены-проверки и pdp-детали).

2.You может явно указать чванство-интерфейс, чтобы показывать только APIs, перечисленный в определенном пути. В приведенном ниже примере он показывает apis, указанный только в ценах.

Для этого вам необходимо настроить этот путь-doc с помощью swagger.

См. this для получения дополнительной информации о аннотациях swagger.

UPDATE:

In- построен чванство-UI search теперь доступна.