在Enterprise Architect中为REST API创建规范

Question

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

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

Answer 1

Sander Hoogendoorn的"Modeling Microservices"演示文稿包含一些有关在Enterprise Architect中建模REST API的有趣幻灯片.该演示文稿可在slideshare.net上获得.最有趣的幻灯片是幻灯片#75.这张幻灯片上显示的图片如下:

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

如果有人有一个Enterprise Architect插件将这些类图转换为Swagger规范(Open API规范),那就太好了.

Answer 2

更新2019/03/18

使用此插件和指南：https://sparxsystems.us/go/restapi/

原答案

我现在正在使用 Enterprise Architect 对 API 进行建模。对于此项目，您的用户被授予购买某些产品的预算。该模型尚未完成，但我将其添加到此处作为参考。

在 EA 中，我添加了一些额外的构造型：路径、资源和表示+新的数据类型 ParamQuery。

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

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