UML 图到模型 API
我需要创建一个图表来记录构建的 RESTFul API,我应该使用哪个 UML 图?
提前致谢,
I need to create a diagram to document a RESTFul API that build, which UML diagram should I use?
Thanks in advance,
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(3)
序列图显示系统的动态。因此,如果您想显示客户端调用您的 API 时发生的调用流程,那么这就是您的选择。
类图显示了系统的结构。因此,如果您想显示 API 的方法/函数签名以及它们如何跨类型分布,那么这就是您应该使用的。
或者您可以使用两者来描述 API 的不同视图。
A sequence diagram shows the dynamics of a system. So, if you want to show the flow of calls that will occur when clients call your API, then that's your choice.
A class diagram shows the structure of a system. So, if you want to show the method/function signatures of your API and how they are distributed across types, then this is what you should use.
Or you could use both to depict different views of your API.
序列图是一个好的开始。但是你最好阅读不同的图表类型来了解你的老板/教授等想。
Sequence diagrams are a good start. But you're better off reading about the different types of diagrams to see what your boss/prof etc want.
这取决于您想要传达的内容,但是在显示 API 时,序列图 是我的首选图表。
It depends what you want to convey, but when showing an API the sequence diagram is my go to diagram.