Hauptfunktionen
Alles, was Sie zum Erstellen, Validieren und Navigieren von OpenAPI-Spezifikationen auf macOS benoetigen.
Intelligenter Code-Editor
Syntaxhervorhebung, Einrueckungslinien, automatische Einrueckung und aktuelle Zeilenhervorhebung fuer JSON und YAML.
Kontextbezogene Vervollstaendigungen
Druecken Sie Ctrl+Space fuer Vorschlaege basierend auf Ihrer Cursorposition im OpenAPI-Schema. Nur gueltige, fehlende Schluessel werden vorgeschlagen.
Inline-Validierung
Validierung gegen die OpenAPI-Spezifikation mit roten und bernsteinfarbenen Wellenlinien direkt im Editor und Hover-Tooltips fuer Details.
Eigenschaftenpanel
Eine strukturierte Ansicht aller API-Operationen mit farbcodierten Methoden-Badges, Parametern, Responses und Klick-Navigation.
Snippet-Vorlagen
Geben Sie ein Ausloesewort ein, um eine Geistertext-Vorschau anzuzeigen, druecken Sie Tab zum Einfuegen und navigieren Sie durch Platzhalter.
Klickbare $ref-Navigation
Cmd+Klick auf einen $ref-Link, um direkt zur Definition im Dokument zu springen.
Konsole
Farbcodiertes Protokollpanel mit erweiterbaren Eintraegen, Klick-Navigation und dokumentbezogenem Protokollverlauf.
Formatkonvertierung
Konvertieren Sie zwischen JSON und YAML mit dem Segmented Control in der Symbolleiste. Struktur und Inhalt bleiben vollstaendig erhalten.
Intelligenter Code-Editor
Ein vollwertiger Texteditor, speziell fuer API-Spezifikationsdateien entwickelt, mit Viewport-First-Rendering auf einem Hintergrund-Thread.
- Syntaxhervorhebung โ Optimiert fuer JSON und YAML mit unterschiedlichen Farben fuer Schluessel, Werte und Trennzeichen
- Einrueckungslinien โ Vertikale Linien zur Visualisierung der Verschachtelungstiefe, mit hervorgehobener aktiver Linie
- Aktuelle Zeilenhervorhebung โ Ein dezenter Hintergrund markiert die aktive Bearbeitungszeile
- Automatische Einrueckung โ Sprachbezogene Regeln fuer JSON und YAML mit automatischem Klammereinfuegen
- Tab / Shift+Tab โ Einzelne Zeilen oder ganze Auswahlen ein- oder ausruecken
- Dunkel- und Hellmodus โ Passt sich automatisch an die macOS-Systemdarstellung an
Kontextbezogene Autovervollstaendigung
Druecken Sie Ctrl+Space, um Vervollstaendigungen auszuloesen. OhAPI Designer analysiert Ihre Cursorposition im OpenAPI-Schema und schlaegt gueltige Schluessel, Werte und Referenzen vor.
- Vollstaendige Abdeckung der OpenAPI 3.0- und 3.1-Spezifikationen
- Vorhandene Schluessel werden herausgefiltert โ nur fehlende Schluessel werden vorgeschlagen
- Einzelne Treffer werden direkt eingefuegt
- Mit Pfeiltasten navigieren, mit Return oder Tab akzeptieren, mit Escape verwerfen
Snippet-Vorlagen
Geben Sie ein Ausloesewort ein und eine halbtransparente Geistertext-Vorschau erscheint inline. Druecken Sie Tab, um das Snippet einzufuegen, und navigieren Sie dann durch Xcode-aehnliche Platzhalter.
Klickbare $ref-Navigation
Alle $ref-Werte werden als blaue, unterstrichene Links dargestellt. Cmd+Klick auf eine Referenz, um direkt zur Definition zu springen.
- #/components/schemas/...
- #/components/parameters/...
- #/components/responses/...
- #/components/requestBodies/...
- #/components/headers/...
OpenAPI-Validierung
Klicken Sie auf die Schaltflaeche Validieren in der Symbolleiste, um Ihr Dokument gegen die OpenAPI-Spezifikation zu pruefen. Fehler und Warnungen erscheinen direkt im Editor.
- Rote Wellenlinien โ Validierungsfehler (fehlende Pflichtfelder, Typenabweichungen, ungueltige Referenzen)
- Bernsteinfarbene Wellenlinien โ Warnungen
- Hover-Tooltips โ Zeigen die Fehlermeldung und den Quellort an
- Markierungen bleiben bei Aenderungen bestehen und verschwinden erst, wenn das Problem behoben ist
Eigenschaftenpanel
Die rechte Seite des Fensters zeigt eine strukturierte Ansicht aller API-Operationen in Ihrem Dokument.
- Operationstabelle โ Jeder Endpunkt mit HTTP-Methode (farbcodiertes Badge), Pfad und Zusammenfassung aufgelistet
- Operationsdetails โ Parameter, Request Body, Responses (farbcodiert nach Statusfamilie), Server, Sicherheit und Tags
- Live-Aktualisierungen โ Aktualisiert sich automatisch bei Bearbeitung, mit Debouncing gegen Flackern
- Klick-Navigation โ Klicken Sie auf eine Operation, um den Editor zur Quellposition zu scrollen
- Veraltete Operationen erscheinen durchgestrichen
Konsole
Ein einklappbares Konsolenpanel am unteren Fensterrand protokolliert Ereignisse waehrend Ihrer Bearbeitungssitzung.
- Farbcodierte Protokollebenen โ Info (blau), Erfolg (gruen), Warnung (orange), Fehler (rot)
- Klick-Navigation โ Protokolleintraege mit Quellort scrollen den Editor zur entsprechenden Zeile
- Dokumentbezogene Protokolle โ Jede geoeffnete Datei hat ihre eigene unabhaengige Konsole
Willkommensbildschirm
Beim Start bietet ein Willkommensbildschirm schnellen Zugriff auf Neues Dokument, Dokument oeffnen und zuletzt geoeffnete Dateien. Er erscheint automatisch wieder, wenn alle Dokumente geschlossen werden.
- Neues Dokument โ Oeffnet das Konfigurationsfenster fuer neue Dokumente
- Dokument oeffnen โ Oeffnet die Dateiauswahl
- Zuletzt geoeffnete Dokumente โ Schnellzugriff auf zuletzt geoeffnete Dateien
Konfiguration neuer Dokumente
Ablage > Neu oeffnet ein Dialogfenster, in dem Sie Ihr neues OpenAPI-Dokument konfigurieren, bevor es erstellt wird.
- Waehlen Sie die OpenAPI-Version: 3.0 oder 3.1
- Waehlen Sie das Format: JSON oder YAML
- Optional einen initialen Pfad mit HTTP-Methoden-Checkboxen definieren
Tastaturkuerzel
| Tastaturkuerzel | Aktion |
|---|---|
| Cmd+N | Neues Dokument |
| Cmd+O | Dokument oeffnen |
| Cmd+S | Speichern |
| Cmd+Z | Rueckgaengig |
| Cmd+Shift+Z | Wiederherstellen |
| Ctrl+Space | Autovervollstaendigung ausloesen |
| Tab | Geistervorschlag akzeptieren / naechster Platzhalter / einruecken |
| Shift+Tab | Vorheriger Platzhalter / ausruecken |
| Escape | Popup schliessen / Platzhaltermodus beenden |
| Option+Return | Snippet-Vorschlag ausloesen |
| Cmd+Klick | Zum $ref-Ziel navigieren |
| Cmd+? | Benutzerhandbuch oeffnen |
Fuer wen ist es gedacht?
OhAPI Designer wurde fuer alle entwickelt, die mit OpenAPI-Spezifikationen auf macOS arbeiten.
API-Entwickler
Entwerfen und pflegen Sie REST-APIs mit kontextbezogenen Werkzeugen.
Backend-Ingenieure
Bearbeiten Sie API-Vertraege neben Ihrer Codebasis.
Technische Redakteure
Dokumentieren Sie APIs mit praezisen, validierten Spezifikationen.
API-Architekten
Ueberpruefen und strukturieren Sie grosse OpenAPI-Dokumente visuell.
Kompatibilitaet
| Format | Dateierweiterungen |
|---|---|
| JSON | .json |
| YAML | .yaml, .yml |
| OpenAPI-Version | Status |
|---|---|
| OpenAPI 3.0 | Unterstuetzt |
| OpenAPI 3.1 | Unterstuetzt |
| Voraussetzung | Minimum |
|---|---|
| Betriebssystem | macOS 12.0 (Monterey) |
| Architektur | Intel & Apple Silicon |
Support kontaktieren
Wenn Sie Fragen haben, zoegern Sie nicht, uns zu kontaktieren.
Was ist die Datenschutzrichtlinie von OhAPI Designer?
Wir erheben keinerlei persoenliche Daten.