【问题标题】:Raml to dto or dto to Raml. what should be better?Raml 到 dto 或 dto 到 Raml。什么应该更好?
【发布时间】:2018-07-12 07:21:19
【问题描述】:

从设计的角度来看,在开发之前,在将合约分享给消费者之前应该有什么更好的方法,先创建 RAML,然后生成 DTOS,反之亦然?

【问题讨论】:

  • 您的意思是 DTO 作为从您的 API 返回的对象吗?
  • 是请求/响应对象。

标签: java specifications raml


【解决方案1】:

据我了解,没有区别,因为都应该这样做

RAML 用于记录和定义 DTO 发挥重要作用的 API。没有适当 DTO 的已定义资源是未完成的 API。同时,资源名称、查询参数和其他一些 API 细节是首先要定义的,所以我会先定义 RAML。此外,当消费者处于比获取数据更复杂的级别并且具有一些业务逻辑时,如果未定义 DTO,则更改 API 的使用可能会非常昂贵。因此,我建议事先同意这一点。

在 API 实施开始之前不可能查看所有详细信息,但在 API 需求发生变化时,最好在技术设计阶段多花几个小时,而不是在实施阶段花几天或几周时间。

【讨论】:

  • 是的,但问题是在设计合同时,我遇到了这样一种情况,合同很容易发生变化,首先创建 RAML 看起来效率不高,因为每次我都必须更改 DTO(添加一个新的字段,返回类型等)RAML 需要改变,我觉得我应该先创建 DTO,然后生成最终的 raml。
  • 好吧,我同意我们来回传递的对象是重要的部分,但我不认为 RAML 生成应该首先阻止创建 RAML。为什么是个大问题?我认为生成它不需要很长时间。
  • 这不是问题,但要求消费者一次又一次地根据新的 raml 重新生成 dto 似乎不合适。相反,我们可以等待并在 dto 最终确定后创建最终合同。只是一个权衡,但没什么不好。
猜你喜欢
  • 2016-01-11
  • 2015-09-13
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2017-11-14
  • 1970-01-01
  • 2012-07-28
  • 1970-01-01
相关资源
最近更新 更多