在Sequence Diagrams中对API请求建模的适当方法是什么？

Question

我即将创建一些序列图来模拟Web API中的交互。

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

说，我有一个API调用来从API端点请求属性。使用这样的标准回复模式是否合适？分配使用多个返回值变量（encrypted_attributes, hashes）？

是不错的样式

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

Answer 1

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

1） Sparx Systems Enterprise Architect可以使用＆＃34;隐式返回消息＆＃34;来绘制同步消息。如下所示：http://www.sparxsystems.com/resources/uml2_tutorial/uml2_sequencediagram.html

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

2） Google：＆＃34; uml序列图最佳做法＆＃34;返回多个具有优点/缺点的资源，其中包括：https://softwareengineering.stackexchange.com/a/166021/129832

3）通常在需要这样的决定时，遵循阻力最小的路径（仅铺设了几英里......）也称为KISS principle是一个很好的指南