So organisieren / erstellen Sie eine Swagger-Benutzeroberfläche für ein Verzeichnis, das viele .json / .yml-Swagger-Definitionsdateien enthält

Ich versuche, über die Swagger-Benutzeroberfläche vorhandene API-Services, die in einem Anbieterprodukt (WSO2 ESB) entwickelt wurden, für den internen Unternehmensverbrauch zu dokumentieren. Das Produkt des Anbieters unterstützt Swagger nicht. Ich plane, den Quellcode für meine API-Services (geschrieben im Produkt des Anbieters) programmgesteuert zu untersuchen / zu verarbeiten und ein Verzeichnis / einen Ordner / eine Bibliothek mit Swagger-Definitionsdateien im Format .json oder .yml zu erstellen. Das ist in Ordnung, das kann ich.

Jede dieser API-Definitionsdateien wird in der Swagger-Benutzeroberfläche gut wiedergegeben. Ich sehe die Verwendung von https: //www.npmjs.com/package/swagger-u.

Mein Problem ist, dass ich am Ende ungefähr 100 dieser API-Definitionsdateien haben werde. Ich möchte eine übergreifende Schnittstelle / Seite bereitstellen, die alle APIs auflistet und den Benutzer dann zur Swagger-Benutzeroberfläche mit der speziellen API-Definition führt, die beim Laden des Benutzers geladen wird klickt auf einen der links. Dies entspricht dem Öffnen meiner lokalen swagger-ui und dem manuellen Eingeben / Kopieren des Pfads zur entsprechenden API-Definition. Dies funktioniert gut, wenn ich es manuell mache. Ich möchte nur nicht, dass der Benutzer dies manuell machen muss. Woher wissen sie, welche API-Definitions-URLs vorhanden sind und warum sie diese manuell eingeben / kopieren müssen.

Ich kann nicht sehen, wie ein "apiDefintionToLoad" -Parameter an Swagger-ui übergeben wird. Ich denke, ich werde entweder einen finden oder die Quelle ändern, um dies zu unterstützen. Existiert das?

Gibt es eine bessere Lösung, entweder mich selbst zu entwickeln oder ein vorhandenes Paket oder eine Lösung zu verwenden? Ich bevorzuge knotenbasierte Lösungen, Java ist auch ok.

Bin ich dabei falsch?

anke, Mat

Antworten auf die Frage(4)

Ihre Antwort auf die Frage