如何在数据流图中正确表示前后端API的只读/读写操作关系?
数据流图读写关系的正确表示方式
首先明确核心原则:数据流图的箭头必须始终指向数据实际流动的方向,不能为了标注读取动作调转箭头,否则会违背数据流图的通用绘制规范,造成理解歧义。
具体可以用以下几种方式标注只读关系,不需要改动原有数据流箭头:
- 给数据流箭头补充属性标注
直接在后端指向前端的数据流箭头上添加文字标注,比如只读数据流、仅GET请求响应,如果需要体现前端的主动读取动作,可以额外添加一根细虚线箭头从前端指向后端,标注读请求触发,用虚线和实线明确区分请求动作和实际数据传输,不会产生逻辑冲突。 - 给接口添加类型标记
直接在后端API模块旁标注只读API、无写入权限,看图者可以直接理解前端仅能从该接口拉取数据,无法向后端提交数据。 - 补充说明块明确权限
如果图纸空间足够,可以在对应接口旁添加引用说明:该接口为只读接口,前端仅可读取数据,不可执行写入操作
内容的提问来源于stack exchange,提问作者Adam
相关产品推荐
相关产品推荐

