UML/API:如何为RESTful API建模

Question

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

如果有人有任何想法或可能有任何帮助,我真的很感激.谢谢!

Answer 1

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

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

Answer 2

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

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

这也有很大的帮助:

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

用于设计REST API的软件:

我希望这有帮助.