OhAPI
Un'applicazione macOS nativa per sviluppatori e architetti API. Visualizzi, navighi e comprenda specifiche OpenAPI complesse tramite diagrammi ad albero interattivi, codice con evidenziazione della sintassi e un browser di operazioni strutturato.
Funzionalita principali
Costruito con AppKit e Swift, OhAPI offre un'esperienza nativa e veloce che si integra perfettamente in macOS.
Visualizzazione ad albero interattiva
Trasformi la Sua specificazione API in un ricco diagramma ad albero interattivo con nodi codificati a colori, controlli di espansione/compressione e animazioni fluide.
Visualizzatore di codice con evidenziazione della sintassi
Visualizzi la Sua specificazione grezza con evidenziazione completa della sintassi JSON e YAML, numeri di riga e sincronizzazione della posizione nel codice sorgente con l'albero.
Browser di operazioni
Esplori tutte le operazioni API elencate per metodo HTTP e percorso. Visualizzi i riepiloghi, gli ID delle operazioni e le definizioni di richiesta e risposta.
Risoluzione dei riferimenti
Navighi attraverso i puntatori $ref profondamente annidati nell'intera specificazione con rilevamento automatico dei cicli. Supporta sia i riferimenti OpenAPI 3.x che Swagger 2.0.
Visualizzazione ad albero interattiva
Trasformi la Sua specificazione API in un diagramma ad albero navigabile e interattivo. Ogni tipo di elemento viene visualizzato come un nodo distinto e codificato a colori per un riconoscimento immediato.
- Nodi espandibili/comprimibili — Si concentri su cio che conta
- Clic per selezionare — Evidenzia il codice sorgente corrispondente
- Animazioni fluide — Transizioni dell'albero raffinate
- Navigazione dei riferimenti — Clicchi sui nodi $ref per passare alle definizioni
Visualizzatore di codice con evidenziazione della sintassi
Visualizzi la Sua specificazione grezza con evidenziazione completa della sintassi. Selezionando un nodo dell'albero, il visualizzatore di codice scorre automaticamente alla posizione corrispondente nel sorgente.
- Evidenziazione JSON e YAML — Chiavi, valori e delimitatori ciascuno con colori distinti
- Numeri di riga — Faccia riferimento facilmente a righe specifiche
- Sincronizzazione della posizione nel sorgente — Selezioni un nodo dell'albero, il visualizzatore scorre alla riga corrispondente
- Font SF Mono — Rendering nitido e monospaziato
Browser di operazioni
Navighi nella Sua API per operazione con un browser strutturato e visuale.
- Elenco operazioni — Tutte le operazioni elencate con metodo HTTP e percorso
- Icone dei metodi — GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD, TRACE hanno ciascuno la propria icona visiva
- Dettagli dell'operazione — Visualizzi riepilogo, ID dell'operazione e descrizione
- Esploratore delle risposte — Esplori le definizioni di richiesta e risposta con raggruppamento per codice di stato HTTP
1. Apra la Sua specificazione OpenAPI
Apra i file tramite File > Apri, trascinamento oppure doppio clic dal Finder. OhAPI supporta sia il formato JSON che YAML. Due specificazioni di esempio sono incluse per iniziare immediatamente.
2. Selezioni un'operazione
Esplori e selezioni l'operazione API che desidera esaminare. Visualizzi il riepilogo, l'ID dell'operazione e la descrizione. Scelga quindi un messaggio di richiesta o risposta da ispezionare.
3. Esplori l'albero e il codice sorgente
L'albero interattivo si aggiorna per mostrare la struttura dati del messaggio. Passi il cursore su qualsiasi elemento per vederne la descrizione. Selezioni un nodo per evidenziarne la definizione nel visualizzatore di codice con evidenziazione della sintassi.
Tipi di nodi dell'albero
OhAPI visualizza ogni elemento OpenAPI come un nodo visivo distinto e codificato a colori.
Schema
Definizioni dei tipi di dati con tipo, formato e vincoli.
Proprieta
Proprieta degli oggetti con nome, tipo, flag obbligatorio e formato.
Parametro
Parametri di query, percorso, header e cookie.
Riferimento
Puntatori $ref con navigazione con un clic alla definizione di destinazione.
Composizione
Composizione di schemi tramite allOf (intersezione), anyOf (unione) o oneOf (alternative esclusive).
Richiesta e risposta
Corpi delle operazioni con raggruppamento per codice di stato HTTP e nodi del tipo di contenuto.
Panoramica dell'interfaccia
Interfaccia principale di OhAPI con visualizzazione ad albero, visualizzatore di codice e browser di operazioni
Temi e aspetto
OhAPI include un sistema di temi con colori personalizzabili per ogni tipo di nodo. I nodi di proprieta, parametro, riferimento, tipo di contenuto ed errore hanno ciascuno colori di primo piano, riempimento e bordo configurabili.
- Supporta le modalita di aspetto chiaro e scuro di macOS
- Le impostazioni vengono mantenute tra le sessioni
Compatibilita
Versioni OpenAPI supportate
| Versione | Stato |
|---|---|
| Swagger 2.0 | Supportato |
| OpenAPI 3.0.0 | Supportato |
| OpenAPI 3.0.1 | Supportato |
| OpenAPI 3.0.2 | Supportato |
| OpenAPI 3.0.3 | Supportato |
| OpenAPI 3.1.x | Supportato |
Formati supportati
| Formato | Estensioni |
|---|---|
| JSON | .json |
| YAML | .yaml, .yml |
Requisiti di sistema
| Requisito | Minimo |
|---|---|
| Sistema operativo | macOS 12.0 (Monterey) |
| Architettura | Intel e Apple Silicon (Universal) |
Domande frequenti
Posso modificare le specifiche con OhAPI?
No, OhAPI e un visualizzatore di specifiche. Per la modifica, consulti OhAPI Designer.
OhAPI supporta la composizione degli schemi (allOf, oneOf, anyOf)?
Si, OhAPI supporta le parole chiave di composizione allOf (intersezione), anyOf (unione) e oneOf (alternative esclusive).
Quali formati di documento sono supportati?
OhAPI supporta sia il formato JSON (.json) che YAML (.yaml, .yml).
Qual e la politica sulla privacy di OhAPI?
Non raccogliamo alcun dato personale.
Quali versioni di OpenAPI sono supportate?
Swagger 2.0 e OpenAPI da 3.0.0 a 3.1.x sono completamente supportati. La versione viene rilevata automaticamente dalla specificazione.
OhAPI gestisce i riferimenti circolari?
Si, OhAPI include il rilevamento dei cicli che gestisce correttamente i riferimenti $ref circolari, prevenendo la ricorsione infinita.
Posso aprire piu documenti contemporaneamente?
Si, OhAPI e un'applicazione macOS standard basata su documenti. Piu documenti possono essere aperti simultaneamente in finestre separate.
OhAPI supporta la modalita scura?
Si, OhAPI supporta sia la modalita di aspetto chiaro che scuro di macOS con colori dei nodi personalizzabili.
Cerca un editor?
OhAPI Designer e un editor macOS nativo con completamento automatico contestuale, validazione inline e modelli di snippet per specifiche OpenAPI.