Apicurio-studio: Как включить консоль «Попробовать» в Redocly в Apicurio на OpenShift.

Созданный на 26 мая 2021  ·  7Комментарии  ·  Источник: Apicurio/apicurio-studio

Привет, ребята, извините за вопрос, но я искал этот проект и Google и не мог понять, как это сделать. Документы Redocly по этой ссылке описывают, как это сделать в файле Redocly yaml https://redoc.ly/docs/api-reference-docs/console-overview/#enable -the-try-it-api-console, но я Я не уверен, как это сделать в установке Docker / k8s. Я не вижу подходящих переменных окружения. Заранее благодарю за любую помощь.

question

Самый полезный комментарий

Возможно, я буду заинтересован в участии, я буду на связи!

Все 7 Комментарий

Хороший вопрос. Приятно знать, есть ли способ включить функцию «Попробовать» в студии APICurio.

Насколько я понимаю, функция «Попробовать» в ReDoc не включена в предложение с открытым исходным кодом. Поэтому я не думаю, что есть способ включить его в Studio. Если я ошибаюсь, я буду очень рад это узнать. :)

@EricWittmann
RapiDoc и SwaggerUI имеют возможность попробовать, а Redoc - нет. Было бы неплохо иметь возможность переключаться между пользовательскими интерфейсами документов, есть ли планы на это?

RapiDoc
https://mrin9.github.io/RapiDoc/index.html
Swagger UI
https://swagger.io/tools/swagger-ui/

Интересно, что у нас уже есть экспериментальная поддержка Rapidoc в функции предварительного просмотра. Если вы добавите &rid=rapidoc к URL-адресу предварительного просмотра, вы увидите его. Например:

image

Соответствующий код находится здесь:

https://github.com/Apicurio/apicurio-studio/blob/master/front-end/servlet/src/main/java/io/apicurio/studio/fe/servlet/servlets/PreviewServlet.java#L78 -L82

Сделать вклад для других средств визуализации, таких как Swagger UI, не составит труда!

Круто, мне нравится внешний вид Rapidoc, хотя в Apicurio функция «Попробовать» отключена:
https://github.com/Apicurio/apicurio-studio/blob/dfc277b03032562e4a3d37f16c851159340495b0/front-end/servlet/src/main/resources/io/apicurio/studio/fe/servlet/servlets/preview_rapid8

Чтобы включить его, установите allow-try=true или удалите атрибут, так как по умолчанию используется значение true.

Ах да - извините за это, я забыл, что специально отключил эту функцию. Я не помню мыслительный процесс, но, вероятно, ни в одном из моих описаний API не было реальных сервисов, поддерживающих их.

Я думаю, что здесь можно легко выполнить некоторую работу, которая упростит включение / отключение этих функций. Я буду рад помочь любому, кто хочет внести свой вклад! Нам нужно будет подумать о том, как позволить пользователям выбирать между рендерерами, устанавливать рендерер по умолчанию, настраивать рендереры либо глобально, либо, возможно, для каждого проекта.

Возможно, я буду заинтересован в участии, я буду на связи!

Была ли эта страница полезной?
0 / 5 - 0 рейтинги