UML / API:如何为RESTful API建模

时间:2017-05-15 20:17:33

标签: rest api symfony uml api-platform.com

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

如果有人有任何想法或可以提供任何帮助,我会非常感激。谢谢!

4 个答案:

答案 0 :(得分:6)

所以解决我的问题的方法有以下几点:

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

这也有很大的帮助:

另一种(更简单的)方法是使用像Pikturr这样的工具,它将你的Swagger转换为UML图。

用于设计REST API的软件:

  • 视觉范例
  • IBM Rational Software Architect

我希望这会有所帮助。

答案 1 :(得分:4)

Api Platform会在网址http://localhost/docs.json自动生成API的Swagger文档。

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

等工具从Swagger文档生成UML图表

答案 2 :(得分:-1)

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

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

您可以使用此内容Visual Paradigm - How to Design REST API with UML?。表示您的REST API很容易。我更喜欢Postman Collections BTW(它不是UML)。

但是,如果您出于文档目的正在做其他种类的UML工件。好吧,Visual Paradigm为您提供了一堆UML图。因此,您可以保留图的生态系统。

再见

答案 3 :(得分:-1)

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