OhAPI Designer
Un editor nativo de macOS creado para especificaciones OpenAPI. Autocompletado contextual, validacion en linea, plantillas de snippets y un panel visual de operaciones — todo en una sola ventana.
Funciones principales
Todo lo que necesita para crear, validar y navegar especificaciones OpenAPI en macOS.
Editor de codigo inteligente
Resaltado de sintaxis, guias de indentacion, indentacion automatica y resaltado de linea actual para JSON y YAML.
Autocompletado contextual
Pulse Ctrl+Space para obtener sugerencias basadas en la posicion del cursor dentro del esquema OpenAPI. Solo se proponen claves validas y ausentes.
Validacion en linea
Valide contra la especificacion OpenAPI con subrayados ondulados rojos y ambar directamente en el editor y tooltips flotantes para detalles.
Panel de propiedades
Una vista estructurada de todas las operaciones API con badges de metodo codificados por color, parametros, respuestas y navegacion por clic.
Plantillas de snippets
Escriba una palabra clave para previsualizar texto fantasma, pulse Tab para insertar y navegue por los marcadores de posicion.
Navegacion $ref clicable
Cmd+Clic en cualquier enlace $ref para saltar directamente a su definicion dentro del documento.
Consola
Panel de registro codificado por colores con entradas expandibles, navegacion por clic e historial de registro por documento.
Conversion de formato
Convierta entre JSON y YAML con el control segmentado de la barra de herramientas. La estructura y el contenido se conservan completamente.
Editor de codigo inteligente
Un editor de texto completo disenado especificamente para archivos de especificacion API, con renderizado viewport-first en un hilo de fondo.
- Resaltado de sintaxis — Optimizado para JSON y YAML con colores distintos para claves, valores y delimitadores
- Guias de indentacion — Lineas verticales que visualizan la profundidad de anidacion, con la guia activa resaltada
- Resaltado de linea actual — Un fondo sutil marca la linea de edicion activa
- Indentacion automatica — Reglas adaptadas al lenguaje para JSON y YAML con insercion automatica de llaves
- Tab / Shift+Tab — Indentar o desindentar lineas individuales o selecciones completas
- Modo oscuro y claro — Se adapta automaticamente a la apariencia del sistema macOS
Autocompletado contextual
Pulse Ctrl+Space para activar el autocompletado. OhAPI Designer analiza la posicion del cursor dentro del esquema OpenAPI y sugiere claves, valores y referencias validos.
- Cobertura completa de las especificaciones OpenAPI 3.0 y 3.1
- Las claves existentes se filtran — solo se sugieren las claves ausentes
- Las coincidencias unicas se insertan directamente
- Navegue con las teclas de flecha, acepte con Return o Tab, descarte con Escape
Plantillas de snippets
Escriba una palabra clave y aparecera una previsualizacion semitransparente de texto fantasma en linea. Pulse Tab para aceptar el snippet y luego navegue por los marcadores de posicion estilo Xcode.
Navegacion $ref clicable
Todos los valores $ref se muestran como enlaces azules subrayados. Cmd+Clic en una referencia para saltar directamente a su definicion.
- #/components/schemas/...
- #/components/parameters/...
- #/components/responses/...
- #/components/requestBodies/...
- #/components/headers/...
Validacion OpenAPI
Haga clic en el boton Validar de la barra de herramientas para verificar su documento contra la especificacion OpenAPI. Los errores y advertencias aparecen directamente en el editor.
- Subrayados ondulados rojos — Errores de validacion (campos obligatorios faltantes, discrepancias de tipo, referencias invalidas)
- Subrayados ondulados ambar — Advertencias
- Tooltips flotantes — Muestran el mensaje de error y la ubicacion en el codigo fuente
- Las marcas persisten durante las ediciones y desaparecen solo cuando el problema se resuelve
Panel de propiedades
El lado derecho de la ventana muestra una vista estructurada de todas las operaciones API en su documento.
- Tabla de operaciones — Cada endpoint listado con su metodo HTTP (badge codificado por color), ruta y resumen
- Detalles de operacion — Parametros, cuerpo de solicitud, respuestas (codificadas por color segun familia de estado), servidores, seguridad y etiquetas
- Actualizaciones en vivo — Se actualiza automaticamente al editar, con debouncing para evitar parpadeos
- Navegacion por clic — Haga clic en una operacion para desplazar el editor a su ubicacion en el codigo fuente
- Las operaciones obsoletas aparecen con texto tachado
Consola
Un panel de consola plegable en la parte inferior de la ventana registra eventos durante su sesion de edicion.
- Niveles de registro codificados por color — Info (azul), Exito (verde), Advertencia (naranja), Error (rojo)
- Navegacion por clic — Las entradas de registro con ubicacion de origen desplazan el editor a la linea correspondiente
- Registros por documento — Cada archivo abierto tiene su propia consola independiente
Pantalla de bienvenida
Al iniciar, una pantalla de bienvenida ofrece acceso rapido a Nuevo documento, Abrir documento y archivos recientes. Reaparece automaticamente cuando se cierran todos los documentos.
- Nuevo documento — Abre el dialogo de configuracion de nuevo documento
- Abrir documento — Abre el selector de archivos
- Documentos recientes — Acceso rapido a archivos abiertos recientemente
Configuracion de nuevo documento
Archivo > Nuevo abre un dialogo donde configura su nuevo documento OpenAPI antes de crearlo.
- Elija la version de OpenAPI: 3.0 o 3.1
- Elija el formato: JSON o YAML
- Opcionalmente defina una ruta inicial con casillas de verificacion de metodos HTTP
Atajos de teclado
| Atajo | Accion |
|---|---|
| Cmd+N | Nuevo documento |
| Cmd+O | Abrir documento |
| Cmd+S | Guardar |
| Cmd+Z | Deshacer |
| Cmd+Shift+Z | Rehacer |
| Ctrl+Space | Activar autocompletado |
| Tab | Aceptar sugerencia fantasma / siguiente marcador / indentar |
| Shift+Tab | Marcador anterior / desindentar |
| Escape | Cerrar popup / salir del modo marcador |
| Option+Return | Activar sugerencia de snippet |
| Cmd+Clic | Navegar al destino $ref |
| Cmd+? | Abrir manual de usuario |
¿Para quien es?
OhAPI Designer esta disenado para cualquier persona que trabaje con especificaciones OpenAPI en macOS.
Desarrolladores de API
Disene y mantenga APIs REST con herramientas contextuales.
Ingenieros backend
Edite contratos de API junto a su codigo fuente.
Redactores tecnicos
Documente APIs con especificaciones precisas y validadas.
Arquitectos de API
Revise y estructure documentos OpenAPI grandes de forma visual.
Compatibilidad
| Formato | Extensiones |
|---|---|
| JSON | .json |
| YAML | .yaml, .yml |
| Version de OpenAPI | Estado |
|---|---|
| OpenAPI 3.0 | Compatible |
| OpenAPI 3.1 | Compatible |
| Requisito | Minimo |
|---|---|
| Sistema operativo | macOS 12.0 (Monterey) |
| Arquitectura | Intel & Apple Silicon |
¿Busca un visor?
OhAPI visualiza sus especificaciones OpenAPI como diagramas de arbol interactivos con un navegador de operaciones estructurado y un visor de codigo con resaltado de sintaxis.
Contactar con soporte
Si tiene alguna pregunta, no dude en contactarnos.
¿Cual es la politica de privacidad de OhAPI Designer?
No recopilamos ningun dato personal.