Мне нужно создать диаграмму классов UML и диаграмму вариантов использования для RESTFul API, который я разработал с использованием платформы API и Symfony 3.2 (бэкенд) и Ionic 2 (интерфейс). Но я точно не знаю, как описать структуру моего внутреннего API через диаграмму классов.
Если у кого-то есть идеи или может помочь, я был бы очень признателен. Благодарю вас!
Итак, решение моей проблемы заключалось в следующем:
https://www.ibm.com/developerworks/rational/library/design-implement-restful-web-services/ : из этого я сделал вывод, что, хотя трудно смоделировать restful API на диаграмме классов (поскольку это в основном просто множество методов), рассмотрите такие классы, как «Ресурсы», добавьте методы (в основном методы HTTP) и пути к каждому ресурсу.
Это тоже очень помогло:
Другой (более простой) способ заключался в использовании таких инструментов, как Pikturr, которые преобразуют ваш Swagger в диаграмму UML.
Программное обеспечение для разработки REST API:
Надеюсь, это поможет.
Платформа API автоматически создает документацию Swagger для вашего API по URL-адресу http://localhost/docs.json.
Вы можете создать диаграмму UML из документации Swagger, используя такие инструменты, как https://github.com/nrekretep/pikturr
Слишком поздно, но это другой подход.
Если вы не знакомы с Visual Paradigm, вы можете попробовать.
Вы можете использовать этот контент, Visual Paradigm - How to Design REST API с UML?. Легко представить свой REST API. Я предпочитаю Коллекции Postman Кстати (это не UML).
Но если вы делаете какие-то другие артефакты UML для целей документации. Что ж, Visual Paradigm предоставляет вам кучу диаграмм UML для этого. Таким образом, вы сохраняете эту экосистему диаграмм.
До встречи.
Настоящим ответом на этот вопрос является использование диаграммы компонентов UML, поскольку сама ее цель заключается в моделировании архитектур на основе служб. Перейдите по этой ссылке для получения дополнительной информации: https://diagramasuml.com/componentes/
