借助plantuml代理服务实现在markdown中绘制原型图
文章目录
【注意】最后更新于 October 13, 2021,文中内容可能已过时,请谨慎使用。
目的
了解plantuml server 强大的代理功能,实现在github上插入uml原型图。目前使用的方式,在org中插入脚本,生成本地文件,再加载到org中,会产生图片附件,需要维护和空间的占用。经过学习,可以通过代理方式,只需要指定uml的源文件,服务器就可以返回已经绘制原型图。 The servlet for server side
代理服务介绍
通过代理服务,PlantUML 服务器可以从远程plantuml文件中获取uml的源码。
代理服务使用以下 URL 方案: /plantuml/proxy?src=RESOURCE&idx=INDEX&fmt=FORMAT
RESOURCE
: uml源码(如:@startxxx和@endxxx标签)远程文件的完整 URL ,它可以是一个.html
或一个.txt
文件。INDEX
是可选的,它指定当远程文档中有多个图描述时,将解析的图描述的出现(从 0 开始)。它默认为零。FORMAT
是可选的,它指定要返回的格式。支持的值是:png
,svg
,eps
,pstext
和txt
。默认为png
。
例如: http: www.plantuml.com/plantuml/proxy?src=https: raw.github.com/plantuml/plantuml-server/master/src/main/webapp/resource/test2diagrams.txt
>注意远程文档的地址是作为参数指定的,所以不需要对URL进行URL编码。
其他资料
git - How to integrate UML diagrams into GitLab or GitHub - Stack Overflow
Markdown native diagrams with PlantUML | Andreas’ Blog 作者的两个案例: GitHub - anoff/plantbuddy: nodeMCU based moisture monitoring for plants 🌱 wit… GitHub - devradar/devradar: Competence Management for developers
文章作者 iTBoyer
上次更新 2021-10-13