Warm tip: This article is reproduced from serverfault.com, please click

rest-UML / API:如何为RESTful API建模

(rest - UML / API : How to model a RESTful API)

发布于 2017-05-15 20:17:32

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

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

Questioner
Fatimaezzahra Rarhibou
Viewed
11
6,512 2018-08-04 04:49:19

因此,解决我的问题的方法包括以下所有方面:

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

这也有很大的帮助:

另一种(更简单的)方法是使用诸如Pikturr之类的工具,这些工具会将Swagger转换为UML图。

用于设计REST API的软件:

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

我希望这有帮助。