在Enterprise Architect中为REST API创建规范

Question

我的客户希望我使用Enterprise Architect（SparxSystems）为未来的REST API创建规范。可交付成果应该是格式良好的文本（可以是html，docx或rtf）。类图应该给出消息体的图片。

到目前为止我唯一发现的是https://github.com/bayeslife/api-add-in，一个EA生成RAML的插件等等。有人有更好的方法吗？

Answer 1

更新2019/03/18

使用此插件和指南：https://sparxsystems.us/home/software/integration-solutions/restapi/

原始答案

我目前正在使用Enterprise Architect来建模API。对于此项目，您的用户可以获得购买某些产品的预算。该模型尚未完成，但我在此处将其添加为参考。

在EA中，我添加了一些额外的构造型：Path，Resource和Representation +一种新的数据类型ParamQuery。

要为API建模，您需要创建一个新的类图，并从API的根目录开始，作为一个构造型“Application”类。接下来，添加资源和路径。对于每个资源，您需要添加必要的GET，POST，PUT等操作。如果在GET操作的字符串中传递QueryParams，则将它们添加为操作的参数，但是作为QueryParam类型（您需要在第一次创建它）。对于POST操作的消息体，您可以添加它所代表的类类型的参数。

接下来，添加“资源”使用的“表示”类。

Answer 2

Sander Hoogendoorn的“Modeling Microservices”演示文稿包含一些有关在Enterprise Architect中建模REST API的有趣幻灯片。该演示文稿可在slideshare.net上找到。最有趣的幻灯片是幻灯片＃75。这张幻灯片上显示的图片如下：

（类和属性名称是荷兰语.Verklaring表示声明和Verklaringen表示声明。但此示例背后的业务不相关。）

如果有人有一个Enterprise Architect插件将这些类图转换为Swagger规范（Open API规范），那将是很好的。

Answer 3

我建议你使用postmanerator服务自动生成API文档，只需将邮件中的API调用保存在集合中，并将此收集器传递给此服务，它会为你生成文档postmanerator link：postmanerator

我希望我的答案会有用