【发布时间】：2009-11-13 18:18:45
【问题描述】：
我需要创建一个图表来记录构建的 RESTFul API，我应该使用哪个 UML 图表？
提前致谢，
【问题讨论】：
-
@AboutDev 任何人都可以给我一个链接到一个示例或示例 API 建模，比如 Java API，使用序列图吗？
【发布时间】：2009-11-13 18:18:45
【问题描述】：
序列图显示了系统的动态。因此，如果您想显示客户端调用您的 API 时将发生的调用流程，那是您的选择。
类图显示系统的结构。因此，如果您想显示 API 的方法/函数签名以及它们如何跨类型分布，那么这就是您应该使用的。
或者您可以使用两者来描述您的 API 的不同视图。
【讨论】：
-
感谢您的评论 =) 我认为两者的结合将是赢家 =)
-
不客气。根据我的经验，大多数面向函数的 API 最好以类图的形式记录，使用类作为“模块”或“组件”来分组排列函数，并将 API 函数视为方法。这在 API 上提供了比序列图等面向动态的图更好的粒度。
Sequence diagrams 是一个好的开始。但是你最好阅读不同的types of diagrams，看看你的老板/教授等想要什么。
【讨论】：
-
我在考虑使用通信图，但序列图似乎也可行。谢谢，
这取决于您想要传达的内容，但在显示 API 时，sequence diagram 是我的首选图表。
【讨论】：