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

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

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

Ответ 1

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

Ответ 2

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

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

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

Ответ 3

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