Как документировать пользовательские API в расширении Keycloak с помощью Swagger/OpenAPI?JAVA

Программисты JAVA общаются здесь
Ответить Пред. темаСлед. тема
Anonymous
 Как документировать пользовательские API в расширении Keycloak с помощью Swagger/OpenAPI?

Сообщение Anonymous »

Я разрабатываю собственное расширение Keycloak и хочу предоставить пользовательские API как часть конечных точек Keycloak (например, /admin/realms//custom). Кроме того, я хочу документировать эти API с помощью Swagger/OpenAPI и использовать для них пользовательский интерфейс Swagger, аналогично тому, как документируется API администратора Keycloak.
Я подписался. следующие шаги:
  • Создал ресурс JAX-RS для пользовательского API.
  • Зарегистрировал ресурс. используя RealmResourceProvider и RealmResourceProviderFactory.
  • Добавлены зависимости SmallRye OpenAPI и Swagger UI в pom.xml расширения.
  • Попытка добавить свойства Quarkus, связанные с OpenAPI (например, quarkus.swagger-ui.always-include=true) в новом application.properties файл внутри расширения.
Однако API работают, но документация Swagger/OpenAPI не отображается. Application.properties не распознается, а пользовательский интерфейс Swagger недоступен по адресу /swagger-ui или /openapi.
  • Убедился, что расширение было правильно развернуто и пользовательский API работал по адресу http://localhost:8080/admin/realms/master/custom.
  • Проверены зависимости для quarkus-smallrye-openapi и quarkus-swagger-ui в pom.xml.
Несмотря на это усилия, документация Swagger UI и OpenAPI не создается и не доступна.

Подробнее здесь: https://stackoverflow.com/questions/792 ... er-openapi
Реклама
Ответить Пред. темаСлед. тема

Быстрый ответ

Изменение регистра текста: 
Смайлики
:) :( :oops: :roll: :wink: :muza: :clever: :sorry: :angel: :read: *x)
Ещё смайлики…
   
К этому ответу прикреплено по крайней мере одно вложение.

Если вы не хотите добавлять вложения, оставьте поля пустыми.

Максимально разрешённый размер вложения: 15 МБ.

  • Похожие темы
    Ответы
    Просмотры
    Последнее сообщение

Вернуться в «JAVA»