在序列图中对 API 请求进行建模的正确方法是什么？

Question

我将创建一些序列图来对 Web API 中的交互进行建模。

有一种重复的请求/响应调用模式，我不确定如何建模。

假设我有一个 API 调用来从 API 端点请求属性。使用这样的标准回复模式是否合适？使用多个返回值变量进行赋值（encrypted_attributes, hashes）是一种好的风格吗？

或者应该像这样创建自定义请求/响应，以反映 和request_attributest都是return_encrypted_attributes由彼此独立的单元完成的？

Answer 1

什么是合适的或什么是好的风格的答案只能基于意见。我对这个问题没有强烈的意见，但我可以看到一些决策点：

1) Sparx Systems Enterprise Architect 可以使用“隐式返回消息”绘制同步消息，如下所示：http://www.sparxsystems.com/resources/uml2_tutorial/uml2_sequencediagram.html

只有 1 行（不是 2 行）。图表更简单，更容易阅读。

2) Google：“uml 序列图最佳实践”返回了一些具有优点/缺点的资源。

3)通常，当需要做出这样的决定时，遵循阻力最小的路径（仅铺好第一英里..）也称为KISS 原则是一个很好的指导