API应该自行消耗还是直接为其他资源调用数据库?

时间:2013-08-25 22:20:21

标签: php api rest oauth internals

  

这个问题是的扩展,虽然是<{3}}的

所以我们有一个车库有多辆车的基本例子,所以我们的终点是

/garages
/garages/{id}
/garages/{id}/cars
/garages/{id}/cars/{id}
/cars
/cars/{id}

我们可以通过/cars?garage[id]=1,2,3

从多个车库获取所有车辆

很酷。但我现在想知道的是API的内部。

我可以通过两种方式来做到这一点:

/ cars端点

中的直接过滤

这意味着我们在查询中获取我们做某些连接的汽车并添加到某些地方。

这种方法的好处是我们最终会得到最少量的查询 这种方法的结果是我们最终在两个地方维护车库资源。任何时候车库获得一个新的财产,我们现在必须支持汽车终端。

从/ cars端点

调用/ garages端点

这意味着我们从/ cars端点调用/ garages端点/车库返回匹配车库中所有车辆的id。然后我们继续从/ cars端点返回汽车。

这种方法的好处是资源是自包含的 这种方法的结果是我们最终将对数据库进行多次调用。传递身份验证细节也会变得很麻烦(让我们假设Oauth 2.0)

那么最合适的方法是什么?我倾向于第二种方法但是我担心如果我们想要做一些更高级的查询,这可能会变得非常麻烦。

2 个答案:

答案 0 :(得分:3)

使用您自己的端点(这被称为service layering并且有许多好处),但不要与您的端点紧密耦合。

首先,我不会通过数字ID进行查询,因为这与您的实现紧密相关。如果您使用URL作为车库标识符,那么您将获得更大的灵活性,并且可以轻松地在其他系统中添加对您车库的支持。

使用hypermedia controls(即链接和表单)在汽车列表中添加搜索表单。让我们假设您的汽车列表看起来像(为了简洁而排除方案和主机)

<cars self="/cars">
    <car href="/cars/0"/>
    <car href="/cars/1"/>
    ...
</cars>

注意:您需要向汽车添加一些摘要属性(例如注册,品牌,型号等,以使搜索更有意义,而无需返回完整的汽车实体)。< / p>

要添加搜索,我们可以添加类似

的内容
<cars self="/cars">
    <car href="/cars/0"/>
    <car href="/cars/1"/>
    ...
    <form name="search" action="/cars" method="get">
        <input name="garage" type="URL"/>
        <!-- other things to search for can go here -->
    </form>
</cars>

在您的资源库(例如数据库)中,如果您的汽车存储了他们所在的车库的URL,则可以执行此查询而无需查询车库,并且如上所述支持在完全不同的系统中拥有车库,假设其他系统使用您的media-type或您支持他们的媒体类型。

显然,您在搜索时需要访问车库URL,这也可以通过车库搜索来完成。 e.g。

<garages self="/garages">
    <garage href="/garage/0"/>
    <garage href="/garage/1"/>
    ...
    <form name="search" action="/garages" method="get">
        <input name="paint" type="string"/>
        <!-- other things to search for can go here -->
    </form>
</garages>

因此流程将是,当用户想要在多个车库中搜索汽车时,他们首先搜索那些车库并将他们感兴趣的车库添加到列表中(这只是一个URL列表) 。然后他们使用车库清单作为输入来搜索汽车。

在这种情况下,车库和汽车仅通过URL耦合。

您可以通过在车库集合上搜索汽车搜索来进一步扩展这一点。例如,只是说我们搜索了黄色油漆的车库,我们可能会得到像

这样的集合
<garages self="/garages?paint=yellow">
    <garage href="/garage/24"/>
    <garage href="/garage/36"/>
    ...
</garages>

要获取此集合的汽车列表,我们可以添加如下链接

<garages self="/garages?paint=yellow">
    <garage href="/garage/24"/>
    <garage href="/garage/36"/>
    <link rel="cars" href="/cars?garage=/garage/24,/garage/36"/>
</garages>

这适用于小型车辆或车库,但当车库列表增长时会出现问题,在这种情况下,车辆的URL会变得太长。

相反,我们可以使用搜索的URL作为输入参数。如,

<garages self="/garages?paint=yellow">
    <garage href="/garage/24"/>
    <garage href="/garage/36"/>
    <link rel="cars" href="/cars?garages=/garages?paint=yellow"/>
</garages>

在这种情况下,当您按照汽车链接时,您的服务将需要执行车库查询,检索每个车库的汽车列表,然后返回合并的汽车列表。除了较短的URL之外,这个查询的好处是它总是会给你带有黄色油漆的车库列表,当车库的油漆变化时会发生事件。

您的服务如何获得车库的汽车清单?车库实体可以链接到汽车收藏。 e.g。

<garage self="/garage/24">
    ... details about the garage ...
    <link rel="cars" href="/cars?garage=/garages/24"/>
</garages>

正如我在顶部所说,使用您自己的端点,但通过假设它们是您自己的端点,与它们紧密耦合。为您的实体构建超媒体控件,并在您的服务需要使用它们时,像对待任何其他外部API一样对待它们。

最后(稍微偏离topc),为了支持大量的汽车和车库,您可以为您的收藏添加分页。 e.g。

<garages self="/garages?page=2">
    <garage href="/garage/10"/>
    <garage href="/garage/11"/>
    ...
    <link rel="next" href="/garages?page=3"/>
    <link rel="prev" href="/garages"/>
</garages>

您甚至可能希望考虑让您的收藏集符合RFC5005 Paged FeedsComplete Feeds,因此可以使用标准工具。

<强>更新

这是一个使用JSON中的超媒体控件的车库集合示例,使用上面的一些概念:

{
    "self": "/garages?paint=yellow&page=2",
    "garages": [
        {
            "href": "/garage/24"
            //... summary properties for this garage go here ...
            //... you can even add a "media-types" array, to tell the service consumer
            //    what media types the garage is available in... 
        },
        {
            "href": "/garage/36"
        }
    ],
    "next": {
        "href": "/garages?paint=yellow"
    },
    "prev": {
        "href": "/garages?paint=yellow&page=3"
    },
    "cars": {
        "href": "/cars?garages=/garages?paint=yellow"
    },
    "search": {
        "href": "/garages?paint=yellow",
        "method": "GET",
        "inputs": {
            ... form input parameters go here ...
        }
    }
}

答案 1 :(得分:0)

好吧,好消息是它在幕后,所以如果你犯了错误,你可以稍后改变你的实现。我肯定也会选择#2。在您知道自己是否存在性能问题之前尝试摆脱数据库调用,这太像是对我的过早优化。这取决于相关调用的频率以及您需要系统的性能。

传递oauth令牌可能很烦人,但似乎不像在多个地方维护资源那样存在bug风险。