UML Диаграмма для API модели

Question

Мне нужно создать диаграмму для документирования API RESTFul, который строит, какую диаграмму UML мне следует использовать?

Заранее спасибо,

Answer 1

A диаграмма последовательности показывает динамику системы. Итак, если вы хотите показать поток вызовов, которые будут происходить, когда клиенты будут вызывать ваш API, то это ваш выбор.

Диаграмма классов показывает структуру системы. Итак, если вы хотите показать сигнатуры методов / функций вашего API и то, как они распределены по типам, то это то, что вы должны использовать.

Или вы можете использовать оба варианта для отображения различных представлений вашего API.

Answer 2

Диаграммы последовательности - хорошее начало. Но вам лучше прочитать о различных типах диаграмм , чтобы узнать, чего хочет ваш босс / проф и т. Д.

Answer 3

Это зависит от того, что вы хотите передать, но при отображении API диаграмма последовательности - это мой переход к диаграмме.