Belangrijkste functies
Alles wat u nodig hebt om OpenAPI-specificaties te schrijven, valideren en navigeren op macOS.
Intelligente code-editor
Syntaxmarkering, inspringgidsen, automatische inspringing en markering van de actieve regel voor JSON en YAML.
Contextbewuste aanvullingen
Druk op Ctrl+Spatie voor suggesties op basis van uw cursorpositie binnen het OpenAPI-schema. Alleen geldige, ontbrekende sleutels worden voorgesteld.
Inline validatie
Valideer tegen de OpenAPI-specificatie met rode en oranje golvende onderstrepingen direct in de editor en zweefinfo voor details.
Eigenschappenpaneel
Een gestructureerd overzicht van alle API-operaties met kleurgecodeerde methodebadges, parameters, antwoorden en klik-om-te-navigeren.
Snippetsjablonen
Typ een triggertrefwoord om een spooktekstvoorbeeld te bekijken, druk op Tab om in te voegen en navigeer vervolgens door plaatshouders.
Klikbare $ref-navigatie
Cmd+Klik op een $ref-koppeling om rechtstreeks naar de definitie in het document te springen.
Console
Kleurgecodeerd logpaneel met uitklapbare items, klik-om-te-navigeren en loggeschiedenis per document.
Formaatconversie
Converteer tussen JSON en YAML met het gesegmenteerde besturingselement in de werkbalk. Structuur en inhoud worden volledig behouden.
Intelligente code-editor
Een volledig uitgeruste teksteditor speciaal ontworpen voor API-specificatiebestanden, met viewport-first rendering op een achtergrondthread.
- Syntaxmarkering โ Geoptimaliseerd voor JSON en YAML met afzonderlijke kleuren voor sleutels, waarden en scheidingstekens
- Inspringgidsen โ Verticale lijnen die de nestingsdiepte visualiseren, met de actieve gids gemarkeerd
- Markering actieve regel โ Een subtiele achtergrond markeert de actieve bewerkingsregel
- Automatische inspringing โ Taalbewuste regels voor zowel JSON als YAML met automatisch invoegen van haakjes
- Tab / Shift+Tab โ Inspringen of uitspringen van enkele regels of volledige selecties
- Donkere en lichte modus โ Past zich automatisch aan de macOS-systeemweergave aan
Contextbewuste automatische aanvulling
Druk op Ctrl+Spatie om aanvullingen te activeren. OhAPI Designer analyseert uw cursorpositie binnen het OpenAPI-schema en stelt geldige sleutels, waarden en referenties voor.
- Volledige dekking van OpenAPI 3.0- en 3.1-specificaties
- Bestaande sleutels worden uitgefilterd โ alleen ontbrekende sleutels worden voorgesteld
- Enkele kandidaatovereenkomsten worden direct ingevoegd
- Navigeer met pijltoetsen, accepteer met Return of Tab, verwerp met Escape
Snippetsjablonen
Typ een triggertrefwoord en een semi-transparant spooktekstvoorbeeld verschijnt inline. Druk op Tab om het snippet te accepteren en navigeer vervolgens door plaatshouders in Xcode-stijl.
Klikbare $ref-navigatie
Alle $ref-waarden worden weergegeven als blauwe, onderstreepte koppelingen. Cmd+Klik op een referentie om rechtstreeks naar de definitie te springen.
- #/components/schemas/...
- #/components/parameters/...
- #/components/responses/...
- #/components/requestBodies/...
- #/components/headers/...
OpenAPI-validatie
Klik op de werkbalkknop Valideren om uw document te controleren tegen de OpenAPI-specificatie. Fouten en waarschuwingen verschijnen direct in de editor.
- Rode golvende onderstrepingen โ Validatiefouten (ontbrekende verplichte velden, typeverschillen, ongeldige referenties)
- Oranje golvende onderstrepingen โ Waarschuwingen
- Zweefinfo โ Toont het foutbericht en de bronlocatie
- Decoraties blijven bestaan bij bewerkingen en verdwijnen pas wanneer het probleem is opgelost
Eigenschappenpaneel
De rechterkant van het venster toont een gestructureerd overzicht van alle API-operaties in uw document.
- Operatietabel โ Elk eindpunt vermeld met de HTTP-methode (kleurgecodeerde badge), pad en samenvatting
- Operatiedetails โ Parameters, verzoeklichaam, antwoorden (kleurgecodeerd per statusfamilie), servers, beveiliging en tags
- Live updates โ Wordt automatisch vernieuwd tijdens het bewerken, met debouncing om flikkeren te voorkomen
- Klik-om-te-navigeren โ Klik op een operatie om de editor naar de bronlocatie te scrollen
- Verouderde operaties worden weergegeven met doorgehaalde tekst
Console
Een inklapbaar consolepaneel onderaan het venster logt gebeurtenissen tijdens uw bewerkingssessie.
- Kleurgecodeerde logniveaus โ Info (blauw), Succes (groen), Waarschuwing (oranje), Fout (rood)
- Klik-om-te-navigeren โ Logitems met een bronlocatie scrollen de editor naar de relevante regel
- Logs per document โ Elk geopend bestand heeft een eigen onafhankelijke console
Welkomstscherm
Bij het opstarten biedt een welkomstscherm snelle toegang tot Nieuw document, Document openen en recente bestanden. Het verschijnt automatisch opnieuw wanneer alle documenten zijn gesloten.
- Nieuw document โ Opent het configuratievenster voor een nieuw document
- Document openen โ Opent de bestandskiezer
- Recente documenten โ Snelle toegang tot recent geopende bestanden
Configuratie nieuw document
Archief > Nieuw opent een venster waarin u uw nieuwe OpenAPI-document configureert voordat het wordt aangemaakt.
- Kies de OpenAPI-versie: 3.0 of 3.1
- Kies het formaat: JSON of YAML
- Definieer optioneel een initieel pad met selectievakjes voor HTTP-methoden
Sneltoetsen
| Sneltoets | Actie |
|---|---|
| Cmd+N | Nieuw document |
| Cmd+O | Document openen |
| Cmd+S | Opslaan |
| Cmd+Z | Ongedaan maken |
| Cmd+Shift+Z | Opnieuw |
| Ctrl+Spatie | Automatische aanvulling activeren |
| Tab | Spooksuggestie accepteren / volgende plaatshouder / inspringen |
| Shift+Tab | Vorige plaatshouder / uitspringen |
| Escape | Pop-up sluiten / plaatshoudermodus verlaten |
| Option+Return | Snippetsuggestie activeren |
| Cmd+Klik | Naar $ref-doel navigeren |
| Cmd+? | Gebruikershandleiding openen |
Voor wie is het?
OhAPI Designer is gebouwd voor iedereen die met OpenAPI-specificaties werkt op macOS.
API-ontwikkelaars
Ontwerp en onderhoud REST API's met contextbewuste tooling.
Backend-engineers
Bewerk API-contracten naast uw codebase.
Technisch schrijvers
Documenteer API's met nauwkeurige, gevalideerde specificaties.
API-architecten
Beoordeel en structureer grote OpenAPI-documenten visueel.
Compatibiliteit
| Formaat | Extensies |
|---|---|
| JSON | .json |
| YAML | .yaml, .yml |
| OpenAPI-versie | Status |
|---|---|
| OpenAPI 3.0 | Ondersteund |
| OpenAPI 3.1 | Ondersteund |
| Vereiste | Minimum |
|---|---|
| Besturingssysteem | macOS 12.0 (Monterey) |
| Architectuur | Intel en Apple Silicon |
Neem contact op met ondersteuning
Hebt u vragen? Aarzel niet om contact met ons op te nemen.
Wat is het privacybeleid van OhAPI Designer?
Wij verzamelen geen enkel persoonlijk gegeven.