OhAPI
Eine native macOS-Anwendung fuer Entwickler und API-Architekten. Visualisieren, navigieren und verstehen Sie komplexe OpenAPI-Spezifikationen durch interaktive Baumdiagramme, syntaxhervorgehobenen Code und einen strukturierten Operationsbrowser.
Hauptfunktionen
Mit AppKit und Swift entwickelt, bietet OhAPI ein schnelles, natives Erlebnis, das sich auf macOS wie zu Hause anfuehlt.
Interaktive Baumvisualisierung
Verwandeln Sie Ihre API-Spezifikation in ein reichhaltiges, interaktives Baumdiagramm mit farbcodierten Knoten, Auf-/Zuklapp-Steuerung und fliessenden Animationen.
Syntaxhervorgehobener Code-Viewer
Betrachten Sie Ihre Rohspezifikation mit vollstaendiger JSON- und YAML-Syntaxhervorhebung, Zeilennummern und Quellposition-Synchronisation mit dem Baum.
Operationsbrowser
Durchsuchen Sie alle API-Operationen nach HTTP-Methode und Pfad. Zeigen Sie Zusammenfassungen, Operations-IDs an und erkunden Sie Request- und Response-Definitionen.
Referenzaufloesung
Navigieren Sie tief verschachtelte $ref-Zeiger in der gesamten Spezifikation mit automatischer Zykluserkennung. Unterstuetzt sowohl OpenAPI 3.x- als auch Swagger 2.0-Referenzen.
Interaktive Baumvisualisierung
Verwandeln Sie Ihre API-Spezifikation in ein navigierbares, interaktives Baumdiagramm. Jeder Elementtyp wird als eindeutiger, farbcodierter Knoten dargestellt, um sofort erkannt zu werden.
- Auf-/Zuklappbare Knoten — Konzentrieren Sie sich auf das Wesentliche
- Klicken zum Auswaehlen — Hebt den entsprechenden Quellcode hervor
- Fliessende Animationen — Elegante Baumuebergaenge
- Referenznavigation — Klicken Sie auf $ref-Knoten, um zu Definitionen zu springen
Syntaxhervorgehobener Code-Viewer
Betrachten Sie Ihre Rohspezifikation mit vollstaendiger Syntaxhervorhebung. Die Auswahl eines Baumknotens scrollt den Code-Viewer automatisch zur entsprechenden Quellposition.
- JSON- & YAML-Hervorhebung — Schluessel, Werte und Trennzeichen jeweils in unterschiedlichen Farben
- Zeilennummern — Einfache Referenzierung bestimmter Zeilen
- Quellposition-Synchronisation — Waehlen Sie einen Baumknoten, der Code-Viewer scrollt zur passenden Zeile
- SF Mono Schrift — Klare, nichtproportionale Darstellung
Operationsbrowser
Navigieren Sie Ihre API nach Operation mit einem strukturierten, visuellen Browser.
- Operationsliste — Alle Operationen mit HTTP-Methode und Pfad aufgelistet
- Methoden-Icons — GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD, TRACE haben jeweils ein eigenes visuelles Icon
- Operationsdetails — Zusammenfassung, Operations-ID und Beschreibung anzeigen
- Response-Explorer — Request- und Response-Definitionen mit HTTP-Statuscode-Gruppierung durchsuchen
1. Oeffnen Sie Ihre OpenAPI-Spezifikation
Oeffnen Sie Dateien ueber Ablage > Oeffnen, Drag-and-Drop oder Doppelklick im Finder. OhAPI unterstuetzt sowohl JSON- als auch YAML-Formate. Zwei mitgelieferte Beispielspezifikationen ermoeglichen einen sofortigen Einstieg.
2. Waehlen Sie eine Operation
Durchsuchen und waehlen Sie die API-Operation, die Sie erkunden moechten. Sehen Sie Zusammenfassung, Operations-ID und Beschreibung. Waehlen Sie dann eine Request- oder Response-Nachricht zur Inspektion.
3. Erkunden Sie Baum und Quellcode
Der interaktive Baum aktualisiert sich und zeigt die Nachrichtendatenstruktur. Bewegen Sie den Mauszeiger ueber ein Element, um seine Beschreibung zu sehen. Waehlen Sie einen Knoten, um seine Definition im syntaxhervorgehobenen Code-Viewer hervorzuheben.
Baumknotentypen
OhAPI stellt jedes OpenAPI-Element als eindeutigen, farbcodierten visuellen Knoten dar.
Schema
Datentypdefinitionen mit Typ, Format und Einschraenkungen.
Eigenschaft
Objekteigenschaften mit Name, Typ, Pflichtmarkierung und Format.
Parameter
Query-, Path-, Header- und Cookie-Parameter.
Referenz
$ref-Zeiger mit Ein-Klick-Navigation zur Zieldefinition.
Komposition
Schema-Komposition durch allOf (Schnittmenge), anyOf (Vereinigung) oder oneOf (exklusive Alternativen).
Request & Response
Operationskoerper mit HTTP-Statuscode-Gruppierung und Content-Type-Knoten.
Oberflaechenuebersicht
OhAPI main interface with tree visualization, code viewer, and operation browser
Design und Erscheinungsbild
OhAPI enthaelt ein Designsystem mit anpassbaren Farben fuer jeden Knotentyp. Eigenschafts-, Parameter-, Referenz-, Content-Type- und Fehlerknoten haben jeweils konfigurierbare Vordergrund-, Fuell- und Rahmenfarben.
- Unterstuetzt macOS Hell- und Dunkel-Erscheinungsmodi
- Einstellungen werden sitzungsuebergreifend gespeichert
Kompatibilitaet
| OpenAPI-Version | Status |
|---|---|
| Swagger 2.0 | Unterstuetzt |
| OpenAPI 3.0.0 | Unterstuetzt |
| OpenAPI 3.0.1 | Unterstuetzt |
| OpenAPI 3.0.2 | Unterstuetzt |
| OpenAPI 3.0.3 | Unterstuetzt |
| OpenAPI 3.1.x | Unterstuetzt |
Formate & Systemanforderungen
| Anforderung | Details |
|---|---|
| JSON-Format | .json |
| YAML-Format | .yaml, .yml |
| Betriebssystem | macOS 12.0 (Monterey) oder hoeher |
| Architektur | Intel und Apple Silicon (Universal) |
Haeufig gestellte Fragen
Kann ich Spezifikationen mit OhAPI bearbeiten?
Nein, OhAPI ist ein Spezifikations-Viewer. Zum Bearbeiten empfehlen wir OhAPI Designer.
Unterstuetzt OhAPI Schema-Komposition (allOf, oneOf, anyOf)?
Ja, OhAPI unterstuetzt vollstaendig die Kompositions-Schluesselwoerter allOf (Schnittmenge), anyOf (Vereinigung) und oneOf (exklusive Alternativen).
Welche Dokumentformate werden unterstuetzt?
OhAPI unterstuetzt sowohl JSON (.json) als auch YAML (.yaml, .yml) Formate.
Wie lautet die Datenschutzrichtlinie von OhAPI?
Wir erheben keinerlei persoenliche Daten.
Welche OpenAPI-Versionen werden unterstuetzt?
Swagger 2.0 und OpenAPI 3.0.0 bis 3.1.x werden vollstaendig unterstuetzt. Die Version wird automatisch aus der Spezifikation erkannt.
Behandelt OhAPI zirkulaere Referenzen?
Ja, OhAPI enthaelt eine Zykluserkennung, die zirkulaere $ref-Referenzen elegant behandelt und unendliche Rekursion verhindert.
Kann ich mehrere Dokumente gleichzeitig oeffnen?
Ja, OhAPI ist eine Standard-macOS-dokumentbasierte Anwendung. Mehrere Dokumente koennen gleichzeitig in separaten Fenstern geoeffnet werden.
Unterstuetzt OhAPI den Dunkelmodus?
Ja, OhAPI unterstuetzt sowohl den macOS Hell- als auch Dunkel-Erscheinungsmodus mit anpassbaren Knotenfarben.
Suchen Sie einen Editor?
OhAPI Designer ist ein nativer macOS-Editor mit kontextbezogener Autovervollstaendigung, Inline-Validierung und Snippet-Vorlagen fuer OpenAPI-Spezifikationen.