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

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

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

3 ответов


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


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

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

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


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