UML图表用于建模API

Question

19

我需要创建一个图表来记录我建立的RESTful API，我应该使用哪种UML图表？

谢谢提前。

- Hugo

@AboutDev 有没有人能够为我提供一个示例或样本建模API的链接，例如使用序列图的Java API？ - Debashisenator

3个回答

15

序列图是一个不错的开始。但最好阅读有关不同图表类型的内容，以了解您的上司/教授等需要什么。

- AboutDev

我在考虑使用通信图，但时序图似乎也是可行的。谢谢。 - Hugo

3

这取决于您想传达什么，但在展示API时，时序图是我常用的图表。

- Ry4an Brase

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- CesarGon · Accepted Answer

序列图展示了系统的动态。如果您想展示客户调用您的API时将发生的调用流程，那么这是您的选择。

类图显示了系统的结构。因此，如果您想展示API的方法/函数签名以及它们如何分布在类型之间，那么这就是您应该使用的内容。

或者您可以同时使用两种图表来展示API的不同视图。