OpenAPI Design-First-API-Referenz

Question

Ich versuche, eine REST-API-Referenz mit dem OpenAPI-Format (v2) zu dokumentieren. Ich möchte, dass es "design-first" ist, was bedeutet, dass meine Swagger-Spezifikation der Vertrag der API-Implementierung sein wird.

Ich habe viele Module und Lösungen ausprobiert, z. swagger-node (zu sehr über Ordnerstruktur und Implementierung), swaggerize-express die zwingt mich, Express, etc. zu verwenden Ich versuchte auch eine Generator-openapi-Repo aber es scheint veraltet und nicht mehr gepflegt.

Gibt es eine Lösung, um eine REST-API-Referenz, Design-First und ohne die Dokumentation mit der tatsächlichen Implementierung zu dokumentieren?

Answer 1

Sie können swagger-node nur als lokaler Editor verwenden. Mit diesen Befehlen führen Sie das Prahlerei-Editor und schreiben Sie Ihre Prahlerei Spezifikation:

npm install -g swagger

swagger project create my-app

swagger project edit

Nach Abschluss der Konstruktion, swagger.yaml-Datei, die in api/swagger/ gespeichert ist, kann verwendet werden für jede Implementierung.

Wenn Sie nach einem Online-Editor suchen, kann das Überprüfen dieser Tools hilfreich sein.

• Einfacher Editor: editor.swagger.io
• zusammenarbeiten Editor (kostenlos & bezahlt Version anbieten): swaggerhub.com