OhAPI
Een native macOS-applicatie voor ontwikkelaars en API-architecten. Visualiseer, navigeer en begrijp complexe OpenAPI-specificaties via interactieve boomdiagrammen, syntaxgemarkeerde code en een gestructureerde operatiebrowser.
Belangrijkste functies
Gebouwd met AppKit en Swift biedt OhAPI een snelle, native ervaring die zich thuis voelt op macOS.
Interactieve boomvisualisatie
Transformeer uw API-specificatie in een rijk, interactief boomdiagram met kleurgecodeerde knooppunten, in- en uitklapbediening en vloeiende animaties.
Syntaxgemarkeerde codeviewer
Bekijk uw ruwe specificatie met volledige JSON- en YAML-syntaxmarkering, regelnummers en bronlocatiesynchronisatie met de boom.
Operatiebrowser
Blader door alle API-operaties per HTTP-methode en pad. Bekijk samenvattingen, operatie-ID's en verken verzoek- en antwoorddefinities.
Referentieresolutie
Navigeer door diep geneste $ref-verwijzingen in de gehele specificatie met automatische cyclusdetectie. Ondersteunt zowel OpenAPI 3.x- als Swagger 2.0-referenties.
Interactieve boomvisualisatie
Transformeer uw API-specificatie in een navigeerbaar, interactief boomdiagram. Elk elementtype wordt weergegeven als een afzonderlijk, kleurgecodeerd knooppunt voor directe herkenning.
- In-/uitklapbare knooppunten — Focus op wat belangrijk is
- Klik-om-te-selecteren — Markeert de overeenkomstige broncode
- Vloeiende animaties — Gepolijste boomovergangen
- Referentienavigatie — Klik op $ref-knooppunten om naar definities te springen
Syntaxgemarkeerde codeviewer
Bekijk uw ruwe specificatie met volledige syntaxmarkering. Door een boomknooppunt te selecteren scrolt de codeviewer automatisch naar de overeenkomstige bronlocatie.
- JSON- en YAML-markering — Sleutels, waarden en scheidingstekens elk in afzonderlijke kleuren
- Regelnummers — Verwijs eenvoudig naar specifieke regels
- Bronlocatiesynchronisatie — Selecteer een boomknooppunt, de codeviewer scrolt naar de overeenkomstige regel
- SF Mono-lettertype — Scherpe, monospaced weergave
Operatiebrowser
Navigeer door uw API per operatie met een gestructureerde, visuele browser.
- Operatielijst — Alle operaties weergegeven met HTTP-methode en pad
- Methodepictogrammen — GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD, TRACE hebben elk hun eigen visueel pictogram
- Operatiedetails — Bekijk samenvatting, operatie-ID en beschrijving
- Antwoordverkenner — Blader door verzoek- en antwoorddefinities met HTTP-statuscodegroeperingen
1. Open uw OpenAPI-specificatie
Open bestanden via Archief > Open, slepen en neerzetten, of dubbelklik vanuit Finder. OhAPI ondersteunt zowel JSON- als YAML-formaten. Twee meegeleverde voorbeeldspecificaties zijn beschikbaar om direct te beginnen.
2. Selecteer een operatie
Blader door en selecteer de API-operatie die u wilt verkennen. Bekijk de samenvatting, operatie-ID en beschrijving. Kies vervolgens een verzoek- of antwoordbericht om te inspecteren.
3. Verken de boom en broncode
De interactieve boom wordt bijgewerkt om de berichtgegevensstructuur te tonen. Zweef over een element om de beschrijving te zien. Selecteer een knooppunt om de definitie in de syntaxgemarkeerde codeviewer te markeren.
Boomknooppunttypen
OhAPI geeft elk OpenAPI-element weer als een afzonderlijk, kleurgecodeerd visueel knooppunt.
Schema
Gegevenstypedefinities met type, formaat en beperkingen.
Eigenschap
Objecteigenschappen met naam, type, verplicht-vlag en formaat.
Parameter
Query-, pad-, header- en cookieparameters.
Referentie
$ref-verwijzingen met navigatie met een klik naar de doeldefinitie.
Compositie
Schemacompositie via allOf (doorsnede), anyOf (unie) of oneOf (exclusieve alternatieven).
Verzoek en antwoord
Operatielichamen met HTTP-statuscodegroeperingen en inhoudstype-knooppunten.
Interface-overzicht
OhAPI hoofdinterface met boomvisualisatie, codeviewer en operatiebrowser
Thema's en weergave
OhAPI bevat een themasysteem met aanpasbare kleuren voor elk knooppunttype. Eigenschap-, parameter-, referentie-, inhoudstype- en foutknooppunten hebben elk configureerbare voorgrond-, vulling- en randkleuren.
- Ondersteunt de lichte en donkere weergavemodi van macOS
- Instellingen worden bewaard tussen sessies
Compatibiliteit
Ondersteunde OpenAPI-versies
| Versie | Status |
|---|---|
| Swagger 2.0 | Ondersteund |
| OpenAPI 3.0.0 | Ondersteund |
| OpenAPI 3.0.1 | Ondersteund |
| OpenAPI 3.0.2 | Ondersteund |
| OpenAPI 3.0.3 | Ondersteund |
| OpenAPI 3.1.x | Ondersteund |
Ondersteunde formaten
| Formaat | Extensies |
|---|---|
| JSON | .json |
| YAML | .yaml, .yml |
Systeemvereisten
| Vereiste | Minimum |
|---|---|
| Besturingssysteem | macOS 12.0 (Monterey) |
| Architectuur | Intel en Apple Silicon (Universal) |
Veelgestelde vragen
Kan ik specificaties bewerken met OhAPI?
Nee, OhAPI is een specificatieviewer. Voor het bewerken kunt u OhAPI Designer gebruiken.
Ondersteunt OhAPI schemacompositie (allOf, oneOf, anyOf)?
Ja, OhAPI ondersteunt allOf (doorsnede), anyOf (unie) en oneOf (exclusieve alternatieven) compositiesleutelwoorden.
Welke documentformaten worden ondersteund?
OhAPI ondersteunt zowel JSON (.json) als YAML (.yaml, .yml) formaten.
Wat is het privacybeleid van OhAPI?
Wij verzamelen geen persoonlijke gegevens.
Welke versies van OpenAPI worden ondersteund?
Swagger 2.0 en OpenAPI 3.0.0 tot en met 3.1.x worden volledig ondersteund. De versie wordt automatisch gedetecteerd uit de specificatie.
Verwerkt OhAPI circulaire referenties?
Ja, OhAPI bevat cyclusdetectie die circulaire $ref-referenties correct afhandelt en oneindige recursie voorkomt.
Kan ik meerdere documenten tegelijk openen?
Ja, OhAPI is een standaard macOS-documentgebaseerde applicatie. Meerdere documenten kunnen gelijktijdig in afzonderlijke vensters worden geopend.
Ondersteunt OhAPI de donkere modus?
Ja, OhAPI ondersteunt zowel de lichte als donkere weergavemodi van macOS met aanpasbare knooppuntkleuren.
Op zoek naar een editor?
OhAPI Designer is een native macOS-editor met contextbewuste automatische aanvulling, inline validatie en snippetsjablonen voor OpenAPI-specificaties.