UML图到模型API

Question

我需要创建一个图来记录构建的RESTFul API，我应该使用哪个UML图？

在此先感谢，

Answer 1

Sequence diagrams是一个好的开始。但你最好阅读不同的types of diagrams来看看你的老板/教授等想要什么。

Answer 2

这取决于你想传达什么，但是当显示一个API时sequence diagram是我去图。

Answer 3

A 序列图显示系统的动态。因此，如果您想要显示客户端调用API时发生的调用流程，那么这是您的选择。

A 类图显示系统的结构。所以，如果你想展示你的API的方法/函数签名以及它们是如何分布在不同类型的，那么这就是你应该使用的。

或者您可以同时使用它们来描述API的不同视图。