Cómo usar esta herramienta de texto
- Pega una descripción OpenAPI en JSON o YAML.
- Elige si quieres conservar o quitar comentarios YAML simples.
- Ejecuta la limpieza.
- Valida después el documento con una herramienta OpenAPI si va a producción.
Limpiador de descripciones OpenAPI
Depura documentos OpenAPI antes de revisarlos, compararlos o incluirlos en documentación. El limpiador elimina espacios finales, reduce líneas vacías repetidas y, cuando lo eliges, retira comentarios de línea en YAML sin tocar URLs ni cadenas JSON. Si la entrada es JSON válida, puede devolver una versión bien indentada. No valida la especificación OpenAPI completa ni modifica archivos remotos.
Entrada de texto
Documento OpenAPI JSON o YAMLEspacio publicitario
Qué hace esta herramienta
Reduce ruido de formato en documentos OpenAPI y normaliza JSON válido. No corrige rutas, esquemas, referencias $ref ni reglas de la especificación.
Primero intenta analizar JSON. Si es válido, lo serializa con indentación uniforme. Si no, trata el texto como YAML y recorta espacios finales, líneas vacías repetidas y comentarios simples según la opción elegida.
Quitar comentarios de YAML puede afectar líneas con sintaxis poco habitual; conserva una copia del original cuando el documento sea importante.
Ejemplo
Una línea YAML con espacios al final y tres líneas vacías consecutivas se reduce a contenido limpio con un máximo de una línea vacía entre bloques.
Casos de uso
- Preparar especificaciones para diffs más claros.
- Limpiar archivos generados antes de documentarlos.
- Reducir ruido de espacios en YAML.
- Normalizar JSON OpenAPI para revisión de código.
Consejos para obtener mejores resultados
- Usa “Limpieza segura” si el documento contiene comentarios relevantes.
- No confundas limpieza con validación de OpenAPI.
- Revisa $ref externos después de mover archivos.
- Conserva el control de versiones para comparar cambios.
Detalles del procesamiento
La herramienta no usa un parser YAML externo. La ruta JSON sí utiliza JSON.parse y JSON.stringify del navegador para producir una salida estructuralmente válida.
La limpieza de YAML es textual y no garantiza semántica YAML completa. Los comentarios embebidos en casos complejos pueden necesitar revisión manual.
Preguntas frecuentes
¿El limpiador OpenAPI valida que mi documento cumpla OpenAPI 3.0 o 3.1?
No. Limpia el formato, pero no comprueba todas las reglas de OpenAPI ni la validez de cada objeto.
¿Qué ocurre si pego una especificación OpenAPI en JSON válido?
Se analiza como JSON y se vuelve a serializar con la sangría seleccionada, lo que normaliza espacios sin cambiar la estructura de datos.
¿La opción de quitar comentarios YAML puede borrar texto después de una URL?
La regla intenta evitar contenido entre comillas y trata comentarios simples. Para YAML complejo, usa la limpieza segura y revisa el resultado.
¿Se modifican las referencias $ref de OpenAPI?
No. El limpiador no resuelve ni reescribe referencias; solo trabaja con el texto del documento.
¿Puedo limpiar una especificación OpenAPI sin subirla a un servidor?
Sí. El procesamiento se hace localmente en el navegador.
Herramientas de texto relacionadas
Resumen técnico
| Módulo | Función |
|---|---|
| Entrada | Documento OpenAPI JSON o YAML |
| Procesamiento | Primero intenta analizar JSON. Si es válido, lo serializa con indentación uniforme. Si no, trata el texto como YAML y recorta espacios finales, líneas vacías repetidas y comentarios simples según la opción elegida. |
| Privacidad | Procesamiento local en el navegador |
| Exportación | TXT y, cuando corresponde, CSV/JSON |
Categoría
Explora más utilidades de desarrollo, formatos y configuración.