如何在 UML 类图中显示 REST API 和数据库连接？

Question

我正在尝试为我的 Web 应用程序创建类图，但我不知道如何在类图中表示数据库连接和 REST API。
附言我正在按照模型视图控制器模式创建类图。

Answer 1

一个类就是一个类

在您的类图中，您对系统的类进行建模。所有的类看起来都一样：

• 一个数据库连接将是一个与另一个类似的类，它将保留有关数据库上下文的一些属性，并提供用于连接和断开给定数据库的方法。
• REST API 类将是一个类（或一组类），与任何其他类一样。如果您是 API 使用者，那么这些类中肯定没有属性（因为 REST 是无状态的，而属性会创建状态）。例如，您可以为可以调用的每个服务提供一个方法。

从概念上讲，系统中的这些类是系统外某些东西的代理，它们会调用数据库和 Web 服务提供的 API。

但也许您想建模其他东西？

如果您的系统提供 API，并且您想展示提供给外部世界的 API 如何与您的内部类相关联，您可能会对使用 composite structure diagram 感兴趣。

如果您想展示您的系统中的不同组件，尤其是如何使用 API 将这些组件连接在一起，您可能会对 component diagram 感兴趣。

如果您的问题不是关于类的结构和系统更深层次的内部结构，而是更多关于显示某些部分位于远程服务器或容器中，您甚至可以考虑deployment diagrams。但这些更多是关于操作基础设施的具体布局，要将其链接到类，您首先需要组件图。