【问题标题】:Naming: What would you call a rich API that wraps around a thin API命名:你会怎么称呼一个围绕瘦 API 的丰富 API
【发布时间】:2010-09-30 18:16:06
【问题描述】:

我有一个“瘦”(SOAP)API,它只知道如何在底层系统中设置和获取实体。

我即将创建一个“丰富”的 API,它封装了“精简”API 并实现了复杂操作所需的逻辑,这些操作需要按特定顺序获取和设置多个实体。

示例:丰富的 API 将负责创建一个新的用户帐户,方法是创建一个通过瘦 API 链接到“帐户”实体的“潜在客户”实体。

我被困在一个命名块中,所以我转向 SO ;) 你会给我丰富的 API 取什么名字? “xxxRichAPI”? “xxx帮手”? “xxx服务”?

【问题讨论】:

  • 这个问题太抽象了,无法回答——尝试一些更具体的例子;)

标签: api naming


【解决方案1】:

API 的意义不在于它隐藏了它的实现吗?因此,您的 API 调用更薄的 API 的事实是无关紧要的。为您的 API 适当地命名它的功能,无论它是如何实现的。

【讨论】:

  • 我当然同意 API 应该隐藏它的实现。但我仍然需要一个名称,将“丰富”或“厚”外观的概念描述为“薄”或“原始”API。就像我有一个系统的准系统接口,我想在它之上构建,在那个系统之外。
【解决方案2】:

乍一看,这听起来像是 GoF Facade 模式。您可能会考虑使用名称“xxxFacade”。

【讨论】:

  • 我不这么认为。 Facade 在多个不同的接口上提供一个接口。
  • 我认为这就是我的目标 - 一个简化的前端,隐藏了复杂的 API。
  • 来自维基百科:“外观是一个对象,它为更大的代码体提供简化的接口,例如类库。”我同意一个外观当然可以包装多个接口,但我不认为它必须
猜你喜欢
  • 2015-08-26
  • 1970-01-01
  • 2014-01-16
  • 2015-10-15
  • 2011-12-02
  • 1970-01-01
  • 2010-11-08
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多