开发者

UML Diagram to Model API

开发者 https://www.devze.com 2022-12-11 04:26 出处:网络
I need to create a diagram to document a RESTFul API that bu开发者_C百科ild, which UML diagram should I use?

I need to create a diagram to document a RESTFul API that bu开发者_C百科ild, which UML diagram should I use?

Thanks in advance,


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.


It depends what you want to convey, but when showing an API the sequence diagram is my go to diagram.

0

精彩评论

暂无评论...
验证码 换一张
取 消