OhAPI
Una aplicacion nativa de macOS para desarrolladores y arquitectos de APIs. Visualice, navegue y comprenda especificaciones OpenAPI complejas mediante diagramas de arbol interactivos, codigo con resaltado de sintaxis y un navegador de operaciones estructurado.
Funciones principales
Desarrollado con AppKit y Swift, OhAPI ofrece una experiencia rapida y nativa que se siente como en casa en macOS.
Visualizacion de arbol interactiva
Transforme su especificacion de API en un diagrama de arbol interactivo y enriquecido con nodos codificados por colores, controles de expandir/contraer y animaciones fluidas.
Visor de codigo con resaltado de sintaxis
Visualice su especificacion sin procesar con resaltado completo de sintaxis JSON y YAML, numeros de linea y sincronizacion de posicion con el arbol.
Navegador de operaciones
Explore todas las operaciones de la API listadas por metodo HTTP y ruta. Vea resumenes, IDs de operacion y explore definiciones de request y response.
Resolucion de referencias
Navegue punteros $ref profundamente anidados en toda la especificacion con deteccion automatica de ciclos. Compatible con referencias OpenAPI 3.x y Swagger 2.0.
Visualizacion de arbol interactiva
Transforme su especificacion de API en un diagrama de arbol navegable e interactivo. Cada tipo de elemento se representa como un nodo distinto y codificado por colores para su reconocimiento inmediato.
- Nodos expandibles/contraibles — Concentrese en lo que importa
- Clic para seleccionar — Resalta el codigo fuente correspondiente
- Animaciones fluidas — Transiciones de arbol elegantes
- Navegacion de referencias — Haga clic en nodos $ref para saltar a las definiciones
Visor de codigo con resaltado de sintaxis
Visualice su especificacion sin procesar con resaltado de sintaxis completo. Al seleccionar un nodo del arbol, el visor de codigo se desplaza automaticamente a la posicion correspondiente en el fuente.
- Resaltado JSON y YAML — Claves, valores y delimitadores cada uno en colores distintos
- Numeros de linea — Referencia facil a lineas especificas
- Sincronizacion de posicion — Seleccione un nodo del arbol, el visor se desplaza a la linea correspondiente
- Fuente SF Mono — Representacion nitida y monoespaciada
Navegador de operaciones
Navegue su API por operacion con un navegador visual y estructurado.
- Lista de operaciones — Todas las operaciones listadas con metodo HTTP y ruta
- Iconos de metodo — GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD, TRACE cada uno con su propio icono visual
- Detalles de operacion — Ver resumen, ID de operacion y descripcion
- Explorador de responses — Explore definiciones de request y response con agrupacion por codigo de estado HTTP
1. Abra su especificacion OpenAPI
Abra archivos mediante Archivo > Abrir, arrastrar y soltar, o doble clic desde Finder. OhAPI es compatible con formatos JSON y YAML. Se incluyen dos especificaciones de ejemplo para comenzar de inmediato.
2. Seleccione una operacion
Explore y seleccione la operacion de API que desea examinar. Vea su resumen, ID de operacion y descripcion. Luego elija un mensaje de request o response para inspeccionar.
3. Explore el arbol y el codigo fuente
El arbol interactivo se actualiza para mostrar la estructura de datos del mensaje. Pase el cursor sobre cualquier elemento para ver su descripcion. Seleccione un nodo para resaltar su definicion en el visor de codigo con resaltado de sintaxis.
Tipos de nodos del arbol
OhAPI representa cada elemento OpenAPI como un nodo visual distinto y codificado por colores.
Schema
Definiciones de tipos de datos con tipo, formato y restricciones.
Propiedad
Propiedades de objeto con nombre, tipo, indicador de obligatorio y formato.
Parametro
Parametros de query, path, header y cookie.
Referencia
Punteros $ref con navegacion de un clic a la definicion de destino.
Composicion
Composicion de schemas mediante allOf (interseccion), anyOf (union) o oneOf (alternativas exclusivas).
Request & Response
Cuerpos de operacion con agrupacion por codigo de estado HTTP y nodos de tipo de contenido.
Vista general de la interfaz
OhAPI main interface with tree visualization, code viewer, and operation browser
Temas y apariencia
OhAPI incluye un sistema de temas con colores personalizables para cada tipo de nodo. Los nodos de propiedad, parametro, referencia, tipo de contenido y error tienen colores configurables de primer plano, relleno y borde.
- Compatible con los modos de apariencia claro y oscuro de macOS
- Los ajustes se conservan entre sesiones
Compatibilidad
| Version de OpenAPI | Estado |
|---|---|
| Swagger 2.0 | Compatible |
| OpenAPI 3.0.0 | Compatible |
| OpenAPI 3.0.1 | Compatible |
| OpenAPI 3.0.2 | Compatible |
| OpenAPI 3.0.3 | Compatible |
| OpenAPI 3.1.x | Compatible |
Formatos y requisitos del sistema
| Requisito | Detalles |
|---|---|
| Formato JSON | .json |
| Formato YAML | .yaml, .yml |
| Sistema operativo | macOS 12.0 (Monterey) o posterior |
| Arquitectura | Intel y Apple Silicon (Universal) |
Preguntas frecuentes
¿Puedo editar especificaciones con OhAPI?
No, OhAPI es un visor de especificaciones. Para editar, consulte OhAPI Designer.
¿OhAPI soporta composicion de schemas (allOf, oneOf, anyOf)?
Si, OhAPI soporta completamente las palabras clave de composicion allOf (interseccion), anyOf (union) y oneOf (alternativas exclusivas).
¿Que formatos de documento son compatibles?
OhAPI es compatible con formatos JSON (.json) y YAML (.yaml, .yml).
¿Cual es la politica de privacidad de OhAPI?
No recopilamos ningun dato personal.
¿Que versiones de OpenAPI son compatibles?
Swagger 2.0 y OpenAPI 3.0.0 hasta 3.1.x son totalmente compatibles. La version se detecta automaticamente a partir de la especificacion.
¿OhAPI maneja referencias circulares?
Si, OhAPI incluye deteccion de ciclos que maneja elegantemente las referencias $ref circulares, previniendo la recursion infinita.
¿Puedo abrir varios documentos a la vez?
Si, OhAPI es una aplicacion estandar de macOS basada en documentos. Se pueden abrir varios documentos simultaneamente en ventanas separadas.
¿OhAPI soporta el modo oscuro?
Si, OhAPI soporta los modos de apariencia claro y oscuro de macOS con colores de nodos personalizables.
¿Busca un editor?
OhAPI Designer es un editor nativo de macOS con autocompletado contextual, validacion en linea y plantillas de snippets para especificaciones OpenAPI.