COMPRPNGJSONAspen FlowSim 设备图标接口
为 Aspen Plus 工艺流程图提供透明背景 PNG 设备符号。图标不含设备位号,可由 CAD 或 Web 端在图标旁独立标注。
调用接口
GET
/api/v1/icons返回全部已登记设备类型、图标地址与元数据地址。
GET
/api/v1/icons/{equipment_type}返回指定设备的 JSON 元数据,包括 PNG 地址、尺寸和是否为回退图标。
GET
/api/v1/icons/{equipment_type}/image返回 image/png 设备图标,可直接作为 <img> 的 src。
GET
/health返回服务状态和当前资源数量。
设备类型要求与回退规则
- equipment_type 使用下方设备库中登记的 Aspen 模块名,例如
RADFRAC、HEATX、PUMP。 - 类型名称区分大小写;建议直接从
/api/v1/icons的列表中取值。 - 请求了尚未收录、拼写错误或不符合规则的类型时,图标接口仍返回
200,但内容为GENERIC_BLOCK通用方块。 - 此时元数据中的
equipment_type为GENERIC_BLOCK,并带有fallback: true;调用方可据此提示用户补充设备符号库。 - 服务已开启跨域访问响应头:
Access-Control-Allow-Origin: *。
调用示例
const type = "RADFRAC";
const imageUrl = `https://api.aspenflowsim.top/api/v1/icons/${type}/image`;
const metadata = await fetch(
`https://api.aspenflowsim.top/api/v1/icons/${type}`
).then((response) => response.json());
// metadata.fallback === true 时,当前使用的是通用方块图标。当前设备图标库
下列图标均为透明 PNG;GENERIC_BLOCK 是未知设备类型的统一回退图形。