Apicurio-studio: Cómo habilitar la consola "Pruébelo" en Redocly en Apicurio en OpenShift.

Creado en 26 may. 2021  ·  7Comentarios  ·  Fuente: Apicurio/apicurio-studio

Hola chicos, perdón por saltar con una pregunta, pero busqué en este proyecto y en Google y no pude encontrar cómo hacerlo. Los documentos de Redocly en este enlace describen cómo hacerlo en el archivo yaml de Redocly https://redoc.ly/docs/api-reference-docs/console-overview/#enable -the-try-it-api-console pero yo No estoy seguro de cómo hacerlo en una instalación de Docker / k8s. No veo ninguna variable ambiental que se aplique. Gracias de antemano por cualquier ayuda.

question

Comentario más útil

Puede que me interese contribuir, ¡estaré en contacto!

Todos 7 comentarios

Buena pregunta. Es bueno saber si hay una manera de habilitar la función "Pruébelo" en APICurio Studio.

Tengo entendido que la función Pruébelo de ReDoc no está incluida en la oferta de código abierto. Así que no creo que haya una forma de habilitarlo en Studio. Si me equivoco, estaré muy feliz de saberlo. :)

@EricWittmann
RapiDoc y SwaggerUI tienen una función de prueba, pero Redoc no. Sería bueno poder cambiar entre las IU de los documentos, ¿hay algún plan para hacerlo?

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

Curiosamente, ya tenemos soporte experimental para rapidoc en la función Vista previa. Si agrega &rid=rapidoc a la URL de vista previa, puede verlo. Por ejemplo:

image

El código relevante está aquí:

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

¡Las contribuciones para otros renderizadores como Swagger UI no serían difíciles!

Genial, me gusta la apariencia de Rapidoc, aunque la función Pruébelo está desactivada en Apicurio:
https://github.com/Apicurio/apicurio-studio/blob/dfc277b03032562e4a3d37f16c851159340495b0/front-end/servlet/src/main/resources/io/apicurio/studio/fe/servlet/servlets/preview#rapido8c.

Para habilitarlo, establezca allow-try=true o elimine el atributo como verdadero es el valor predeterminado.

Ah, sí, lo siento, olvidé que desactivé específicamente esa función. No recuerdo el proceso de pensamiento, pero probablemente ninguna de mis descripciones de API tenía servicios reales que las respaldaran.

Creo que hay algo de trabajo que podría hacerse fácilmente aquí que haría que estas funciones fueran más fáciles de habilitar / deshabilitar. ¡Estaré feliz de guiar a cualquier persona interesada en hacer una contribución! Tendríamos que pensar en cómo permitir a los usuarios elegir entre los renderizadores, establecer un renderizador predeterminado, configurar el renderizador (es) globalmente o quizás por diseño.

Puede que me interese contribuir, ¡estaré en contacto!

¿Fue útil esta página
0 / 5 - 0 calificaciones