Ich habe eine Anwendung mit Node.js/expressjs entwickelt. Es funktioniert gut. Jetzt muss ich API-Dokument mit Swagger generieren. Es gibt ein Modul swagger-node. Muss ich die gesamte App mit diesem Modul neu schreiben oder gibt es eine andere Lösung, um dieses Modul zu verwenden und was nutzt swagger-ui, wenn Sie swagger-node verwenden?Wie node.js API-Dokumente mit Hilfe von Swagger generieren
Nicht von dem, was ich sagen kann. Sie sollten Ihr swagger-Projekt wie beschrieben generieren können und dann sicherstellen, dass die Informationen in der yaml-Datei auf die tatsächlichen Controller und Methoden verweisen, die Ihr Code verwendet.
Sie können eine eigenständige yaml-Datei erstellen, die mit Swagger/OpenAPI kompatibel ist und daher in Swagger-Dokumentation gerendert werden kann. Die Swagger-UI ist nützlich für die Erstellung dieser Yaml-Datei. Swagger bietet auch verschiedene Tools zum Testen von APIs und zum Generieren von Code - um diese effektiv zu nutzen, benötigen Sie eine Methode zur Integration der Controller-/Modelldefinitionen in Ihre YAML-Datei in Ihre vorhandene Codebasis.
Um diese Integration zu erreichen, stelle ich meine vorhandene Codebasis typischerweise als API von Controller-Funktionen zur Verfügung und importiere sie dann als Modul in den Code, der von meiner dokumentierten API generiert wird. Dadurch kann ich meiner API-Dokumentation vertrauen, ohne die gesamte Codebasis in Swaggers erforderliche Verzeichnisstruktur zu portieren. Ich glaube, das ist der beste derzeit verfügbare Ansatz, aber es lohnt sich nicht immer.