在 Enterprise Architect 中为 REST API 创建规范

Create spec for REST API in Enterprise Architect

我的客户希望我使用 Enterprise Architect (SparxSystems) 为未来的 REST API 创建规范。可交付成果应该是格式正确的文本(可以是 html、docx 或 rtf)。 class 图应该给出邮件正文的图片。

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

我建议您使用 postmanerator 服务,它会自动为 API 生成文档,只需将邮递员中的 API 调用保存在一个集合中,并将此收集器传递给此服务,它会为您生成文档 postmanerator link: postmanerator

希望我的回答对你有用

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

(Class 和属性名称是荷兰语。Verklaring 表示声明,Verklaringen 表示声明。但此示例背后的业务无关。)

如果有人能为 Enterprise Architect 提供插件以将这些 class 图表转换为 Swagger 规范(打开 API 规范),那就太好了。

更新 2019/03/18

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

原回答

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

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

要对 API 建模,您需要创建一个新的 class 图,并从 API 的根开始作为构造型“应用程序”的 class。接下来添加资源和路径。对于每个资源,您添加必要的 GET、POST、PUT 等操作。如果 QueryParams 在 GET 操作的字符串中传递,您将它们添加为操作的参数,但作为 QueryParam 类型(您需要在第一次创建它)。对于 POST 操作的消息体,您添加它代表的 class 类型的参数。

接下来添加“表示”classes,供资源使用。