Repolode
yuzutech

yuzutech/kroki

API HTTP unificada que convierte fuentes de diagramas en texto, como PlantUML, Mermaid, D2 y GraphViz, en SVG, PNG y otros formatos de imagen.

Estrellas
4,374
Forks
323
Issues abiertos
142
Último commit
ayer

¿Qué es?

Kroki es una pasarela que convierte descripciones de diagramas en texto en imágenes a través de una única API HTTP. En lugar de instalar un renderizador distinto para cada herramienta, se envía la fuente del diagrama a un endpoint y se especifica el tipo de diagrama, como PlantUML, Mermaid, Graphviz, Ditaa, Excalidraw o Vega-Lite, junto con el formato de salida deseado.

El servidor está escrito en Java sobre Vert.x y se ejecuta como una imagen de Docker. Las solicitudes se pueden enviar como llamadas GET con la URL codificada, cuerpos JSON en solicitudes POST o texto sin formato con encabezados Accept. Algunos renderizadores, como Mermaid, BPMN, Excalidraw y diagrams.net, se ejecutan en contenedores complementarios a los que el servidor principal se conecta mediante variables de entorno.

El proyecto abarca una amplia variedad de tipos de diagramas, como UML, C4, ERD, DBML, BPMN, diagramas de secuencia y de red, diagramas de temporización y de paquetes, y diseños bytefield. Se pueden insertar las imágenes generadas en documentación o páginas web sin instalar cada herramienta de diagramación localmente.

Funciones clave

  • 01API unificada para muchos lenguajes de diagramación
  • 02Acepta solicitudes GET con la fuente codificada, solicitudes POST con JSON o texto sin formato
  • 03Genera SVG, PNG y otros formatos de imagen
  • 04Se ejecuta como imagen de Docker, con contenedores complementarios opcionales para Mermaid, BPMN y Excalidraw
  • 05Permite configurar las conexiones con servicios complementarios mediante variables de entorno

Casos de uso

  • Renderizar diagramas de arquitectura o de secuencia en flujos de documentación
  • Generar imágenes de diagramas para wikis o herramientas de chat a partir de fuentes de texto
  • Alojar un servicio privado de renderizado de diagramas para un equipo interno
  • Insertar vistas previas de diagramas en aplicaciones web sin instalar herramientas localmente

Inicio rápido

  1. 1

    Ejecuta el contenedor de Kroki con Docker

    docker run -d -p 8000:8000 yuzutech/kroki
  2. 2

    Si lo necesitas, inicia contenedores complementarios para Mermaid, BPMN, Excalidraw o diagrams.net con docker-compose

    docker-compose up -d

Antes de usarlo

  • Algunos tipos de diagramas, como Mermaid, BPMN y Excalidraw, requieren iniciar contenedores complementarios adicionales.
  • La integración con diagrams.net es experimental.

Temas

Preguntas frecuentes

¿Qué es kroki?
API HTTP unificada que convierte fuentes de diagramas en texto, como PlantUML, Mermaid, D2 y GraphViz, en SVG, PNG y otros formatos de imagen. Kroki es una pasarela que convierte descripciones de diagramas en texto en imágenes a través de una única API HTTP. En lugar de instalar un renderizador distinto para cada herramienta, se envía la fuente del diagrama a un endpoint y se especifica el tipo de diagrama, como PlantUML, Mermaid, Graphviz, Ditaa, Excalidraw o Vega-Lite, junto con el formato de salida deseado.
¿kroki es gratuito? ¿Qué licencia tiene?
kroki es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿kroki sigue mantenido?
Mantenimiento activo. El último commit de kroki fue el 20 oct 2026.
¿Para qué puedo usar kroki?
Renderizar diagramas de arquitectura o de secuencia en flujos de documentación Generar imágenes de diagramas para wikis o herramientas de chat a partir de fuentes de texto Alojar un servicio privado de renderizado de diagramas para un equipo interno Insertar vistas previas de diagramas en aplicaciones web sin instalar herramientas localmente
¿Cómo se instala kroki?
Ejecuta el contenedor de Kroki con Docker: docker run -d -p 8000:8000 yuzutech/kroki Si lo necesitas, inicia contenedores complementarios para Mermaid, BPMN, Excalidraw o diagrams.net con docker-compose: docker-compose up -d
¿Dónde consigo kroki?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/yuzutech/kroki

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados