Deine API-Spezifikation als Diagramm.
Mit LetDraw kannst du OpenAPI visualisieren: Aus einer Spezifikation wird eine editierbare Karte deiner API. Füg eine OpenAPI-3.x- oder Swagger-2.0-Datei in YAML oder JSON ein und erhalte jeden Endpunkt, gruppiert nach Tag und farbig nach Methode, mit Pfeilen zu den Schemas, die er verwendet.
So visualisierst du eine OpenAPI-Spezifikation
Von openapi.yaml oder swagger.json zu einem Diagramm, das du anordnen und teilen kannst.
Spezifikation bereitlegen
Nimm ein beliebiges OpenAPI-3.x- oder Swagger-2.0-Dokument, in YAML oder JSON. Es braucht einen paths-Abschnitt, aus dem gezeichnet wird.
In „Aus Code generieren“ einfügen
Öffne „Aus Code generieren“ (eine Pro-Funktion) im Menü „Weitere Werkzeuge“ und füge ein. Die Spezifikation wird automatisch erkannt und eine Live-Vorschau erscheint.
Layout wählen
Ordne das Diagramm von oben nach unten oder von links nach rechts an und wechsle zwischen einem klaren und einem skizzenhaften Look.
Einfügen und teilen
Leg es auf die Leinwand, verschiebe Elemente, füge Notizen hinzu, dann teil einen Link oder exportiere als PNG, SVG oder PDF.
OpenAPI-Visualisierung, die Endpunkte mit Schemas verbindet
Jede Operation wird zu einem Kasten mit Methode, Pfad und Zusammenfassung. Operationen werden nach ihrem ersten Tag gruppiert (oder nach dem ersten Pfadsegment, wenn es keinen gibt), und jedes Schema aus components oder den Swagger-definitions bekommt einen eigenen Kasten mit seinen ersten Eigenschaften. Pfeile folgen jeder $ref, von Operationen zu den Schemas, die sie verwenden, und zwischen verschachtelten Schemas.
- OpenAPI 3.x und Swagger 2.0, eingefügt als YAML oder JSON
- Endpunkte nach Tag gruppiert und farbig nach HTTP-Methode
- Pfeile folgen $ref, damit du siehst, welche Endpunkte ein Modell teilen
Swagger visualisieren, für das ganze Team
Eine Spezifikation ist für Maschinen geschrieben; über ein Diagramm können Menschen sprechen.
API-Design-Reviews
Geh eine neue oder geänderte API als Bild durch und kommentiere direkt neben dem betreffenden Endpunkt.
Onboarding
Zeig neuen Entwicklern, welche Endpunkte es gibt und welche Modelle sie teilen, bevor sie einen einzigen Handler lesen.
Partner- und Integrationsdoku
Exportiere einen Überblick über deine öffentliche API als PNG, SVG oder PDF für Guides, Portale und Folien.
Lose Enden finden
Schemas, auf die kein Pfeil zeigt, fallen auf, ebenso Tags, die zu viele Endpunkte angesammelt haben.
Refactorings planen
Füg die aktuelle Spezifikation ein und skizziere daneben auf derselben Leinwand die Zielform der API.
Übergaben zwischen Frontend und Backend
Einigt euch auf Endpunkte und Payloads in einem gemeinsamen Diagramm, das beide Seiten in Echtzeit bearbeiten.
FAQ: OpenAPI visualisieren
Welche Versionen der Spezifikation werden unterstützt?
Verlässt meine Spezifikation den Browser?
Ist das kostenlos?
Kann ich das Diagramm danach bearbeiten?
Weitere Diagramme aus Code
Deine API auf einen Blick.
Öffne LetDraw, füg deine OpenAPI- oder Swagger-Spezifikation ein und erhalte ein Diagramm, das dein ganzes Team lesen kann.