在Enterprise Architect中创建REST API规范

在Enterprise Architect中创建REST API规范,rest,uml,documentation-generation,enterprise-architect,Rest,Uml,Documentation Generation,Enterprise Architect,我的客户希望我使用Enterprise Architect(SparxSystems)为未来的REST API创建一个规范。可交付成果应该是格式良好的文本(可以是html、docx或rtf)。类图应该给出消息体的图片 到目前为止,我发现的唯一一件事是,EA可以生成RAML和更多的插件。有谁有更好的方法吗?我建议您使用postmanerator服务,它会自动为API生成文档,只需将API调用保存在集合中的postman中,并将此收集器传递给此服务它会为您生成文档postmanerator链接:

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


到目前为止,我发现的唯一一件事是,EA可以生成RAML和更多的插件。有谁有更好的方法吗?

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


我希望我的回答会有用

Sander Hoogendoorn的“建模微服务”演示文稿包含了一些关于在Enterprise Architect中建模REST API的有趣幻灯片。该演示文稿可在上获得。最有趣的幻灯片是幻灯片75。下面是该幻灯片上显示的图片:

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


如果有人能为企业架构师提供一个插件,将这些类图转换为招摇过市的规范(开放API规范),那就太好了。

更新2019/03/18

使用此插件和指南:

原始答案

目前我正在使用企业架构师对API进行建模。对于此项目,您的用户被授予购买特定产品的预算。该模型尚未完成,但我在这里添加它作为参考

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

要对API建模,您需要创建一个新的类图,并从API的根开始,将其作为一个原型类“Application”。接下来,添加资源和路径。为每个资源添加必要的GET、POST、PUT等操作。如果在GET操作的字符串中传递QueryParam,则将它们作为操作的参数添加,但作为QueryParam类型(需要第一次创建)。对于POST操作的messagebody,您添加了它所表示的类类型的参数

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


您应该联系Sander Hoogendoorn。他有一种建模微服务的方法,包括EnterpriseArchitect中的RESTAPI。因此,除非你想自己做所有事情,否则上述方法似乎是最好的。@ThomasKilian,你所说的“API方式”是什么意思?奇怪,也许他在度假。但是,是的,他在2015年参加了布鲁塞尔EAUG。请参阅,谢谢,但postmanerator不是使用企业架构师工具的解决方案。提供的URL(不再)解析。更新的URL:。。。但是,请注意,开发人员会考虑API合同(OpenAPI、JSON Schema等)实际上不支持(例如,没有来自YAML或JSON的正向/反向工程)。看起来新的URL在填写和提交营销表单后在404结束。