Apicurio-studio: Como habilitar o console "Try it" no Redocly no Apicurio no OpenShift.

Criado em 26 mai. 2021  ·  7Comentários  ·  Fonte: Apicurio/apicurio-studio

Oi pessoal, desculpem por pular com uma pergunta, mas eu pesquisei esse projeto e o Google e não consegui descobrir como fazer isso. Os documentos do Redocly neste link descrevem como fazer isso no arquivo yaml do Redocly https://redoc.ly/docs/api-reference-docs/console-overview/#enable -the-try-it-api-console, mas eu Não tenho certeza de como fazer isso em uma instalação do Docker / k8s. Não vejo nenhuma variável ambiental que se aplique. Agradecemos antecipadamente por qualquer ajuda.

question

Comentários muito úteis

Posso ter interesse em contribuir, entrarei em contato!

Todos 7 comentários

Boa pergunta. É bom saber se existe uma maneira de habilitar o recurso "Experimente" no APICurio Studio.

Meu entendimento é que o recurso Try It do ReDoc não está incluído na oferta de código aberto. Portanto, não acho que haja uma maneira de habilitá-lo no Studio. Se eu estiver errado, ficarei muito feliz em saber disso. :)

@EricWittmann
O RapiDoc e o SwaggerUI têm um recurso de teste, mas o Redoc não. Seria bom poder alternar entre as interfaces do usuário de documentos. Há algum plano para fazer isso?

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

Curiosamente, já temos suporte experimental para rapidoc no recurso de visualização. Se você adicionar &rid=rapidoc ao URL de visualização, poderá vê-lo. Por exemplo:

image

O código relevante está aqui:

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

Contribuições para outros renderizadores como a IU Swagger não seriam difíceis!

Legal, gosto da aparência do rapidoc, embora o recurso Try it out esteja desativado no Apicurio:
https://github.com/Apicurio/apicurio-studio/blob/dfc277b03032562e4a3d37f16c851159340495b0/front-end/servlet/src/main/resources/io/apicurio/studio/fe/servlet/servlets/preview_rapidoc.template8

Para habilitá-lo, defina allow-try=true ou remova o atributo como verdadeiro é o padrão.

Ah, sim - desculpe por isso, esqueci que desativei especificamente esse recurso. Não me lembro do processo de pensamento, mas provavelmente nenhuma das minhas descrições de API tinha serviços reais para apoiá-los.

Acho que há algum trabalho que poderia ser feito facilmente aqui que tornaria esses recursos mais fáceis de ativar / desativar. Eu ficaria feliz em orientar qualquer pessoa interessada em fazer uma contribuição! Precisamos pensar em como permitir que os usuários escolham entre os renderizadores, definir um renderizador padrão, configurar o (s) renderizador (es) globalmente ou talvez por design.

Posso ter interesse em contribuir, entrarei em contato!

Esta página foi útil?
0 / 5 - 0 avaliações