AngularJS with Hypermedia(HATEOAS):如何在各州使用超媒体网址

时间:2016-08-17 14:01:02

标签: angularjs rest hateoas hypermedia

我的 ui路由器 AngularJS 应用程序使用超媒体消耗 REST API 。一般的想法是让API为其各种调用生成URL,并使客户端不要自己构建URL。

例如,在获取产品列表时,这是API返回的内容:

[
  {
    "id": 1,
    "name": "Product A",
    "_links": {
      "self": {
        "href": "http://localhost:4444/api/products/1",
        "name": null,
        "templated": false
      },
      "actions": []
    }
  },
  {
    "id": 2,
    "name": "Product B",
    "_links": {
      "self": {
        "href": "http://localhost:4444/api/products/2",
        "name": null,
        "templated": false
      },
      "actions": []
    }
  }
]

所以,问题是:我想导航到产品的细节。我有来自超媒体集合的API网址。但是,在更改状态时,我不知何故需要将此URL传递给详细状态,以便详细状态的控制器可以获取产品。

UI网址与API网址完全分离,即客户端有自己的网址方案。

实现此目的的最佳方式是什么,同时保持客户端无状态,每个页面都可收藏?

一种解决方案是通过ui router的{​​{1}}属性传递网址。但是,该页面不是可收藏的。另一种方法是在UI网址中传递API网址,这会使网页保持书签状态(只要API网址不会更改),但网址会非常难看。

还有其他想法吗?

除非我对此非常不对,否则我不是在寻找模板化解决方案,即API返回需要由客户端注入参数的url模板的解决方案。重点是网址已经填充了数据,因为有些网址比上面提供的示例复杂得多。

1 个答案:

答案 0 :(得分:1)

我之前几次遇到过这个问题。我已经在下面逐步详细介绍了我的首选解决方案。最后两个步骤专门针对您帖子中列出的问题,但同样的原则可以应用于整个应用程序。

1。根端点

首先在API级别定义根端点。相应的根实体是顶级链接的集合,换句话说,客户端需要直接访问的链接。

这个想法是客户端只需要知道一个端点,即根端点。这样做的好处是,您不会将路由逻辑复制到客户端,从而使API的版本化变得更加容易。

根据您的示例,此根端点可能如下所示:

{
    "_links": {
      "products": {
        "href": "http://localhost:4444/api/products",
      }
    }
}

2。摘要主要状态

接下来,定义一个位于状态层次结构顶部的抽象超级状态。我通常将此状态命名为 main ,以避免与 root 端点混淆。此超级状态的任务是解析根端点,如:

$stateProvider.state('main', {
    resolve: {
        root: function($http) {
         return $http.get("http://localhost:4444/api/").then(function(resp){
              return resp.data;
         });
        }
    }
});

3。产品概述状态为主要状态的子级

然后创建一个产品状态,它是主状态的后代。由于根端点已经解析,我们可以在此状态下使用它来获取产品API的链接:

 $stateProvider.state('products', {
    parent: 'main',
    url: "/products",
    resolve: {
        products: function($http, root) {
         return $http.get(root._links.products.href).then(function(resp){
              return resp.data;
         });
        }
    }
});

4。产品详细信息状态为产品状态的子项

最后,创建一个产品详细信息状态作为上述产品的子项。通过$stateParams传递产品的ID(因此,它是客户端URI的一部分),并使用它从父级解析的产品数组中检索正确的产品:

$stateProvider.state('products.product', {
    url: "/{productId}"
    resolve: {
        product: function($http, $timeout, $state, $stateParams, $q products) {
         var productId = parseInt($stateParams.productId);
         var product;

        for (var i = 0; i < products.length; i++) {
            product = products[i];
            if (product.id === productId) {
                return $http.get(product._links.self.href).then(function(response){
                    return response.data;
                });
                }
        }

        // go back to parent state if no child was found, do so in a $timeout to prevent infinite state reload
        $timeout(function(){
            $state.go('^', $stateParams);
        });

        // reject the resolve
        return $q.reject('No product with id ' + productId);
    }
});

您可以将上面的代码移动到服务中,以使您的状态更轻量级。

希望这有帮助!