UML / API: 如何建模RESTful API

Question

22

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

如果有人有任何想法或能提供帮助，我将非常感激。谢谢！

- Fatimaezzahra Rarhibou

1

你的问题太基础了（或者说太宽泛了，这取决于你的看法）。那种问题需要“读一本书”或“上课”。 - qwerty_so

@ThomasKilian 感谢您的回复。我的问题是我想知道如何在类图中表示我的API组件。序列图更容易设计，因为您可以描述API和系统之间的交互。但我不知道如何处理类图，如何表示我的API结构。非常感谢您的帮助。 - Fatimaezzahra Rarhibou

仅仅让机器画出“一些东西”并不是真正的文档，我认为。在创建任何软件文档之前，你需要理解类的概念。你需要先放置马车前面的马。 - qwerty_so

1

在StackOverflow上，将解决方案放在答案中（以便其他用户也能受益）是一种常见做法。 :-) - gp_sflover

1

@gp_sflover，我刚刚做了，我还有点新手呢。谢谢！ :) - Fatimaezzahra Rarhibou

显示剩余5条评论

4个回答

8

Api Platform会自动生成一个Swagger文档，您可以在http://localhost/docs.json的链接中查看。您可以使用像https://github.com/nrekretep/pikturr这样的工具从Swagger文档生成UML图。

- Kévin Dunglas

非常感谢您的回复 @Kévin Dunglas，我会尝试这个方法，看起来简单而有效。真是救命恩人！ - Fatimaezzahra Rarhibou

0

虽然现在有点晚了，但这是另一种方法。

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

你可以使用这个内容，Visual Paradigm - 如何使用UML设计REST API？。它很容易，可以代表你的REST API。顺便说一下，我更喜欢Postman Collections（它不是UML）。

但是，如果你正在为文档目的制作其他类型的UML图形。那么，Visual Paradigm会给你提供一堆UML图表来完成这项工作。所以你可以保持那个图表生态系统。

再见。

- Franco Gil

-2

问题的真正答案是使用UML组件图，因为它的目的是基于服务建模架构。请查看此链接以获取更多信息：https://diagramasuml.com/componentes/。

- Ramiro G.M.

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Fatimaezzahra Rarhibou · Accepted Answer

所以解决我的问题的方法包括以下几点：

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

这也非常有帮助：

另一个（更简单）的方法是使用工具如Pikturr，将你的Swagger转换成UML图。

设计REST API的软件：

希望这可以帮到你。