Apicurio-studio: So aktivieren Sie die "Try it"-Konsole in Redocly in Apicurio auf OpenShift.

Erstellt am 26. Mai 2021  ·  7Kommentare  ·  Quelle: Apicurio/apicurio-studio

Hallo Leute, Entschuldigung, dass ich mit einer Frage eingegriffen habe, aber ich habe dieses Projekt und Google durchsucht und konnte nicht herausfinden, wie das geht. Die Redocly-Dokumente unter diesem Link beschreiben die Vorgehensweise in der Redocly-Yaml-Datei https://redoc.ly/docs/api-reference-docs/console-overview/#enable -the-try-it-api-console, aber ich Ich bin mir nicht sicher, wie es in einer Docker/k8s-Installation geht. Ich sehe keine Umgebungsvariablen, die zutreffen würden. Danke im Voraus für jede Hilfe.

question

Hilfreichster Kommentar

Ich habe Interesse an einem Beitrag, ich melde mich!

Alle 7 Kommentare

Gute Frage. Es ist schön zu wissen, ob es eine Möglichkeit gibt, die Funktion "Ausprobieren" in APICurio Studio zu aktivieren.

Nach meinem Verständnis ist die Try-It-Funktion von ReDoc nicht im Open-Source-Angebot enthalten. Ich glaube also nicht, dass es eine Möglichkeit gibt, es in Studio zu aktivieren. Wenn ich falsch liege, freue ich mich sehr darüber. :)

@EricWittmann
RapiDoc und SwaggerUI haben eine Try-It-Funktion, Redoc jedoch nicht. Es wäre schön, zwischen Dokument-UIs wechseln zu können, ist dies geplant?

RapiDoc
https://mrin9.github.io/RapiDoc/index.html
Swagger-Benutzeroberfläche
https://swagger.io/tools/swagger-ui/

Interessanterweise haben wir bereits experimentelle Unterstützung für rapidoc in der Vorschaufunktion. Wenn Sie &rid=rapidoc zur Vorschau-URL hinzufügen, können Sie sie sehen. Zum Beispiel:

image

Der entsprechende Code ist hier:

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

Beiträge für andere Renderer wie Swagger UI wären nicht schwer!

Cool, ich mag das Aussehen und das Gefühl von rapidoc, obwohl die Funktion Ausprobieren in Apicurio deaktiviert ist:
https://github.com/Apicurio/apicurio-studio/blob/dfc277b03032562e4a3d37f16c851159340495b0/front-end/servlet/src/main/resources/io/apicurio/studio/fe/servlet/servlets/preview_rapidoc.template#L8

Um es zu aktivieren, setzen Sie allow-try=true oder entfernen Sie das Attribut als true.

Ah ja - tut mir leid, ich habe vergessen, dass ich diese Funktion ausdrücklich deaktiviert habe. Ich erinnere mich nicht an den Denkprozess, aber wahrscheinlich hatte keine meiner API-Beschreibungen echte Dienste, die sie unterstützten.

Ich denke, es gibt einige Arbeiten, die hier leicht durchgeführt werden könnten, um die Aktivierung/Deaktivierung dieser Funktionen zu erleichtern. Gerne leite ich alle Interessierten an, einen Beitrag zu leisten! Wir müssten darüber nachdenken, wie wir Benutzern die Auswahl zwischen den Renderern ermöglichen, einen Standard-Renderer festlegen, den/die Renderer entweder global oder vielleicht pro Design konfigurieren.

Ich habe Interesse an einem Beitrag, ich melde mich!

War diese Seite hilfreich?
0 / 5 - 0 Bewertungen