SuperAPI AI 工具集

plantuml

通用与其它

查看项目

更新于 10-16 07:28

技能介绍

用途:该技能用于 PlantUML 图表的创建与转换,可依据自然语言描述生成图表,把源码结构转换为架构图,并将 puml 文件转为图片。

主要能力:覆盖 19 种图类型,UML 包括 sequence、class、activity、state、component、deployment、use case、object、timing;非 UML 包括 ER、Gantt、mindmap、WBS、JSON/YAML、network、Archimate、wireframes。支持从 Markdown 中提取 ```puml 代码块和链接的 .puml 文件并生成图片,可仅校验语法,便于 CI/CD。examples/ 下提供 Spring Boot、FastAPI、Python ETL、Node.js、React 的代码转图模板。

使用方式:先运行 python scripts/check_setup.py 检查环境,需要 Java JRE/JDK 8+、plantuml.jar,可选 Graphviz。转换命令为 python scripts/convert_puml.py diagram.puml,可加 --format svg 与 --output-dir images/;处理 Markdown 用 python scripts/process_markdown_puml.py article.md,可加 --format svg 或 --validate。也可直接用 java -jar ~/plantuml.jar diagram.puml 转换,支持 --svg、--output-dir 和批量转换。推荐工作流为识别图类型、按 <markdown_name><num><type>_<title>.puml 命名、转换失败最多重试 3 次、最后验证图片并替换链接。

适用场景:创建各类结构图与流程图、可视化应用架构、为 Confluence/Notion 准备含图的 Markdown 文档、校验 PlantUML 语法。图片格式上 PNG 适合网页发布,SVG 适合文档且支持超链接。

限制:资料未说明收费方式与具体平台支持范围;需自行准备 Java 与 plantuml.jar,缺失时按资料给出的下载地址获取,部分复杂布局依赖 Graphviz。相关错误可查阅 references/troubleshooting/toc.md 等参考文档。