16

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

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

4

4 回答 4

12

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

https://www.ibm.com/developerworks/rational/library/design-implement-restful-web-services/ ：我由此得出结论，虽然很难在类图中建模一个restful api（因为它基本上只是一堆方法），考虑像“资源”这样的类，添加方法（基本上是 HTTP 方法）和每个资源的路径。

这也有很大的帮助：

另一种（更简单）的方法是使用像 Pikturr 这样的工具，它将 Swagger 转换为 UML 图。

用于设计 REST API 的软件：

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

我希望这有帮助。

于 2017-05-17T09:47:46.830 回答
6

Api Platform 会自动在 URL 处为您的 API 生成 Swagger 文档http://localhost/docs.json。

您可以使用https://github.com/nrekretep/pikturr等工具从 Swagger 文档中生成 UML 图

于 2017-05-15T21:49:20.323 回答
-1

这个问题的真正答案是使用UML 组件图，因为它的目的是对基于服务的体系结构进行建模。检查此链接以获取更多信息：https ://diagramasuml.com/componentes/

于 2020-11-29T00:07:08.823 回答
-1

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

如果您不了解Visual Paradigm，可以尝试一下。

您可以使用此内容，Visual Paradigm - 如何使用 UML 设计 REST API？. 表示您的 REST API 很容易。我更喜欢Postman Collections BTW（它不是 UML）。

但是，如果您出于文档目的而做一些其他类型的 UML 工件。好吧，Visual Paradigm 为您提供了一堆 UML 图来做到这一点。所以你保留了图表的生态系统。

再见。

于 2020-06-15T20:44:01.190 回答