UML / API:如何建模 RESTful API

UML / API : How to model a RESTful API

我需要为我使用 API 平台和 Symfony 3.2(后端)开发的 RESTFul API 创建一个 UML class 图和一个用例图和 Ionic 2(前端)。 但是我不知道如何通过 class 图来描述我的后端 API 的结构。

如果有人有任何想法或可以提供任何帮助,我将不胜感激。谢谢!

Api 平台会在 URL http://localhost/docs.json.

自动为您的 API 生成 Swagger 文档

您可以使用 https://github.com/nrekretep/pikturr

等工具从 Swagger 文档生成 UML 图

所以我的问题的解决方案是以下所有内容:

https://www.ibm.com/developerworks/rational/library/design-implement-restful-web-services/ : 我由此得出结论,尽管很难在 class 图中对 restful api 进行建模(因为它基本上只是一堆方法),但请考虑 class 之类的"Resources",添加方法(基本上是 HTTP 方法)和每个资源的路径。

这也帮了大忙:

另一种(更简单的)方法是使用 Pikturr 等工具,它可以将您的 Swagger 转换为 UML 图。

用于设计 REST API 的软件:

  • 视觉范式
  • IBM Rational 软件架构师

希望对您有所帮助。

为时已晚,但这是另一种方法。

如果你不知道 Visual Paradigm 你可以试一试。

您可以使用此内容,Visual Paradigm - How to Design REST API with UML?. It is easy, to represent your REST API. I prefer Postman Collections 顺便说一句(它不是 UML)。

但是,如果您出于文档目的而制作其他类型的 UML 工件。好吧,Visual Paradigm 为您提供了一堆 UML 图来执行此操作。所以你保留了图表的生态系统。

再见。

问题的真正答案是使用 UML 组件图,因为它的真正目的是基于服务对体系结构进行建模。查看此 link 了解更多信息:https://diagramasuml.com/componentes/