OhAPI Designer

Un editor macOS nativo creato appositamente per le specifiche OpenAPI. Completamento automatico contestuale, validazione inline, modelli di snippet e un pannello operazioni visivo — tutto in un'unica finestra.

Funzionalita principali

Tutto cio di cui ha bisogno per scrivere, validare e navigare le specifiche OpenAPI su macOS.

Editor di codice intelligente

Evidenziazione della sintassi, guide di indentazione, indentazione automatica ed evidenziazione della riga attiva per JSON e YAML.

Completamento automatico contestuale

Prema Ctrl+Spazio per suggerimenti basati sulla posizione del cursore all'interno dello schema OpenAPI. Vengono proposte solo le chiavi valide e mancanti.

Validazione inline

Validazione rispetto alla specifica OpenAPI con sottolineature ondulate rosse e ambra direttamente nell'editor e tooltip al passaggio del mouse per i dettagli.

Pannello proprieta

Una vista strutturata di tutte le operazioni API con badge metodo codificati a colori, parametri, risposte e clic per navigare.

Modelli di snippet

Digiti una parola chiave trigger per visualizzare un'anteprima in testo fantasma, prema Tab per inserire, quindi navighi tra i segnaposto.

Navigazione $ref cliccabile

Cmd+Clic su qualsiasi collegamento $ref per saltare direttamente alla sua definizione nel documento.

Console

Pannello di log codificato a colori con voci espandibili, clic per navigare e cronologia dei log per documento.

Conversione di formato

Converta tra JSON e YAML con il controllo segmentato della barra degli strumenti. Struttura e contenuto vengono completamente preservati.

Editor di codice intelligente

Un editor di testo completo progettato specificamente per i file di specifica API, con rendering viewport-first su un thread in background.

Evidenziazione della sintassi — Ottimizzata per JSON e YAML con colori distinti per chiavi, valori e delimitatori
Guide di indentazione — Linee verticali che visualizzano la profondita di annidamento, con la guida attiva evidenziata
Evidenziazione riga attiva — Uno sfondo sottile segna la riga di modifica attiva
Indentazione automatica — Regole consapevoli del linguaggio per JSON e YAML con inserimento automatico delle parentesi
Tab / Shift+Tab — Indenta o riduci l'indentazione di singole righe o intere selezioni
Modalita chiara e scura — Si adatta automaticamente all'aspetto del sistema macOS

Completamento automatico contestuale

Prema Ctrl+Spazio per attivare i completamenti. OhAPI Designer analizza la posizione del cursore all'interno dello schema OpenAPI e suggerisce chiavi, valori e riferimenti validi.

Copertura completa delle specifiche OpenAPI 3.0 e 3.1
Le chiavi esistenti vengono filtrate — vengono suggerite solo le chiavi mancanti
Le corrispondenze con un singolo candidato vengono inserite direttamente
Navighi con i tasti freccia, accetti con Invio o Tab, chiuda con Escape

Modelli di snippet

Digiti una parola chiave trigger e un'anteprima in testo fantasma semi-trasparente appare inline. Prema Tab per accettare lo snippet, quindi navighi tra i segnaposto in stile Xcode.

Navigazione $ref cliccabile

Tutti i valori $ref sono stilizzati come collegamenti blu sottolineati. Cmd+Clic su un riferimento per saltare direttamente alla sua definizione.

#/components/schemas/...
#/components/parameters/...
#/components/responses/...
#/components/requestBodies/...
#/components/headers/...

Validazione OpenAPI

Clicchi sul pulsante Valida nella barra degli strumenti per controllare il documento rispetto alla specifica OpenAPI. Errori e avvisi appaiono direttamente nell'editor.

Sottolineature ondulate rosse — Errori di validazione (campi obbligatori mancanti, disallineamenti di tipo, riferimenti non validi)
Sottolineature ondulate ambra — Avvisi
Tooltip al passaggio — Visualizzano il messaggio di errore e la posizione nel sorgente
Le decorazioni persistono durante le modifiche e scompaiono solo quando il problema e risolto

Pannello proprieta

Il lato destro della finestra mostra una vista strutturata di tutte le operazioni API nel documento.

Tabella operazioni — Ogni endpoint elencato con il metodo HTTP (badge codificato a colori), percorso e riepilogo
Dettagli operazione — Parametri, corpo della richiesta, risposte (codificate a colori per famiglia di stato), server, sicurezza e tag
Aggiornamenti in tempo reale — Si aggiorna automaticamente durante la modifica, con debouncing per evitare sfarfallio
Clic per navigare — Clicchi su un'operazione per scorrere l'editor alla posizione nel sorgente
Le operazioni deprecate appaiono con testo barrato

Console

Un pannello console comprimibile nella parte inferiore della finestra registra gli eventi durante la sessione di modifica.

Livelli di log codificati a colori — Info (blu), Successo (verde), Avviso (arancione), Errore (rosso)
Clic per navigare — Le voci di log con una posizione nel sorgente scorrono l'editor alla riga pertinente
Log per documento — Ogni file aperto ha la propria console indipendente

Schermata di benvenuto

All'avvio, una schermata di benvenuto offre accesso rapido a Nuovo documento, Apri documento e file recenti. Riappare automaticamente quando tutti i documenti vengono chiusi.

Nuovo documento — Apre la finestra di configurazione del nuovo documento
Apri documento — Apre il selettore di file
Documenti recenti — Accesso rapido ai file aperti di recente

Configurazione nuovo documento

Archivio > Nuovo apre una finestra in cui configura il nuovo documento OpenAPI prima che venga creato.

Scelga la versione OpenAPI: 3.0 o 3.1
Scelga il formato: JSON o YAML
Definisca opzionalmente un percorso iniziale con caselle di controllo per i metodi HTTP

Scorciatoie da tastiera

Scorciatoia	Azione
Cmd+N	Nuovo documento
Cmd+O	Apri documento
Cmd+S	Salva
Cmd+Z	Annulla
Cmd+Shift+Z	Ripristina
Ctrl+Spazio	Attiva completamento automatico
Tab	Accetta suggerimento fantasma / segnaposto successivo / indenta
Shift+Tab	Segnaposto precedente / riduci indentazione
Escape	Chiudi popup / esci dalla modalita segnaposto
Option+Invio	Attiva suggerimento snippet
Cmd+Clic	Naviga al target $ref
Cmd+?	Apri manuale utente

A chi e destinato?

OhAPI Designer e stato creato per chiunque lavori con le specifiche OpenAPI su macOS.

Sviluppatori API

Progetti e mantenga REST API con strumenti contestuali.

Ingegneri backend

Modifichi i contratti API insieme alla sua codebase.

Redattori tecnici

Documenti le API con specifiche accurate e validate.

Architetti API

Revisioni e strutturi visivamente documenti OpenAPI di grandi dimensioni.

Compatibilita

Formato	Estensioni
JSON	.json
YAML	.yaml, .yml

Versione OpenAPI	Stato
OpenAPI 3.0	Supportato
OpenAPI 3.1	Supportato

Requisito	Minimo
Sistema operativo	macOS 12.0 (Monterey)
Architettura	Intel e Apple Silicon

Cerca un visualizzatore?

OhAPI visualizza le Sue specifiche OpenAPI come diagrammi ad albero interattivi con un browser di operazioni strutturato e un visualizzatore di codice con evidenziazione della sintassi.

Contatti l'assistenza

Se ha domande, non esiti a contattarci.

Qual e la politica sulla privacy di OhAPI Designer?

Non raccogliamo alcun dato personale.