Apicurio-studio: Comment activer la console "Try it" dans Redocly dans Apicurio sur OpenShift.

Créé le 26 mai 2021  ·  7Commentaires  ·  Source: Apicurio/apicurio-studio

Salut les gars, désolé d'avoir posé une question, mais j'ai recherché ce projet et Google et je n'ai pas trouvé comment faire cela. Les documents Redocly sur ce lien décrivent comment le faire dans le fichier Yaml Redocly https://redoc.ly/docs/api-reference-docs/console-overview/#enable -the-try-it-api-console mais je Je ne sais pas comment le faire dans une installation Docker/k8s. Je ne vois aucune variable environnementale qui s'appliquerait. Merci d'avance pour votre aide.

question

Commentaire le plus utile

Je peux être intéressé à contribuer, je serai en contact!

Tous les 7 commentaires

Bonne question. Il est bon de savoir s'il existe un moyen d'activer la fonction "Essayer" dans le studio APICurio.

Je crois comprendre que la fonctionnalité Try It de ReDoc n'est pas incluse dans l'offre open source. Je ne pense donc pas qu'il existe un moyen de l'activer dans Studio. Si je me trompe, je serai très heureux de le savoir. :)

@EricWittmann
RapiDoc et SwaggerUI ont une fonctionnalité d'essai, mais pas Redoc. Ce serait bien de pouvoir basculer entre les interfaces utilisateur de document, est-il prévu de le faire ?

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

Il est intéressant de noter que nous avons déjà un support expérimental pour rapidoc dans la fonction Aperçu. Si vous ajoutez &rid=rapidoc à l'URL d'aperçu, vous pouvez le voir. Par exemple:

image

Le code correspondant est ici :

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

Les contributions pour d'autres moteurs de rendu comme Swagger UI ne seraient pas difficiles !

Cool, j'aime le look and feel de rapidoc, bien que la fonction Try it out soit désactivée dans Apicurio :
https://github.com/Apicurio/apicurio-studio/blob/dfc277b03032562e4a3d37f16c851159340495b0/front-end/servlet/src/main/resources/io/apicurio/studio/fe/servlet/servlets/preview_rapidoc.template#L8

Pour l'activer, définissez allow-try=true ou supprimez l'attribut car true est la valeur par défaut.

Ah oui - désolé pour ça, j'ai oublié que j'avais spécifiquement désactivé cette fonctionnalité. Je ne me souviens pas du processus de réflexion, mais probablement aucune de mes descriptions d'API n'avait de vrais services pour les soutenir.

Je pense qu'il y a du travail qui pourrait être facilement fait ici qui rendrait ces fonctionnalités plus faciles à activer/désactiver. Je serais heureux de guider toute personne intéressée à apporter une contribution! Nous aurions besoin de réfléchir à la manière de permettre aux utilisateurs de choisir entre les moteurs de rendu, de définir un moteur de rendu par défaut, de configurer le ou les moteurs de rendu soit globalement, soit par conception.

Je peux être intéressé à contribuer, je serai en contact!

Cette page vous a été utile?
0 / 5 - 0 notes