HATEOAS在哈尔的帖子链接

Question

我如何描述HAL中的帖子链接？

我正在设计一个带有HATEOAS约束的RESTful API，类似于Wikipedia的HATEOAS示例，但用HAL JSON表示（为了清晰起见，删除了scheme、host等）：

GET /accounts/12345

{
  "id" : 12345,
  "balance" : 100.00
  "_links" : {
    "self" : {
      "href" : "/accounts/12345"
    },
    "transfer" : {
      "href" : "/accounts/12345/transfer{?amount,target}",
      "templated" : true
    }
  }
}

为了执行“转移”操作，客户大概会这样做：

GET /accounts/12345/transfer?amount=100.00,target=54321

{
  "id" : 34567,
  "amount" : 100.00
  "_links" : {
    "self" : {
      "href" : "/transfers/34567"
    },
    "source" : {
      "href" : "/account/12345"
    },
    "target" : {
      "href" : "/account/54321"
    }
  }
}

通过GET调用“transfer”链接会在“transfers”中创建一个新的ressource。但是创建一个新资源并不是幂等的，它“感觉”不对；以RESTful资源为中心的API将发布：

POST {amount: 10.00, source: 12345, target: 54321}  /transfers/

{
  "id" : 34567,
  "amount" : 100.00
  "_links" : {
    "self" : {
      "href" : "/transfers/34567"
    },
    "source" : {
      "href" : "/account/12345"
    },
    "target" : {
      "href" : "/account/54321"
    }
  }
}

但是我该如何描述这篇文章以及HAL中所需的html" target="_blank">表单元素，这样客户就可以在没有硬编码的情况下做“正确的事情”？也许是这样的：

{
  "id" : 12345,
  "balance" : 100.00
  "_links" : {
    "self" : {
      "href" : "/accounts/12345"
    },
    "transfer" : {
      "href" : "/transfers{?amount,source,target}",
      "templated" : true,
      "method" : "POST"
    }
  }
}

但是method不是HAL规范的一部分，也没有类似的标识符——所以感觉我走错了方向。。。

也许我的客户应该知道，一个GET的传输返回匹配的传输资源，一个POST到传输创建一个新的传输资源。

FWIW，我的实现使用Spring Boot 2和Spring HATEOAS，所以后续问题是如何用Spring HATEOAS表达这一点...

Answer 1

你不能对哈尔这么做。哈尔的创始人迈克·凯利在GitHub上发表声明

这样做的HAL方法是使用链接rel留档以人类可读的形式传达可用的方法。也就是说，你的树皮例子看起来像这样（注意“树皮”链接rel现在是一个网址）

{
   "_links": {
        "http://docs.example.com/barks": { "href": "/v1/dogs/1/barks" }
    }
}

如果开发人员获取URLhttp://docs.example.com/barks在浏览器中，文档可以指定可用的方法、有效的请求主体、潜在的响应代码、响应主体等。然后开发人员将其编码到她正在构建的客户机中。

这是HAL规范imho的一个主要缺陷，但还有其他媒体类型可以解决这个问题，比如Mason或HAL扩展HAL-FORMS。也许值得一看，尽管我不确定它们是如何与Spring集成的。