HAL中的HATEOAS POST链接

Question

如何在HAL中描述POST链接？

我正在设计一个具有HATEOAS约束的RESTful API，类似于Wikipedia的HATEOAS示例，但以HAL JSON表示（为清楚起见，删除了方案，主机等）：

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调用“转移”链接会在“转移”中创建新的资源。 但是，执行GET创建新资源并不是幂等的，它“感觉”到了错误； 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中描述此POST和所需的表单元素，以便客户端可以执行“正确的事情”而无需进行硬编码？ 也许像这样：

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

但是method不是HAL规范的一部分，并且没有类似的标识符-因此感觉就像我走错了路...

也许我的客户应该只是“知道” transfer的GET返回匹配的转移资源，而要transfer的POST transfer创建新的转移资源。

FWIW，我的实现使用带有Spring HATEOAS的Spring Boot 2，因此后续问题是如何使用Spring HATEOAS来表达这一点...

Answer 1

使用HAL无法做到这一点。 HAL的创建者Mike Kelly 在GitHub上声明

“ HAL方式”是使用链接相关文档以人类可读的形式传达可用的方法。 即。 您的树皮示例如下所示（请注意，“树皮”链接rel现在是一个URL）

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

并且如果开发人员在浏览器中获取URL http://docs.example.com/barks ，则文档可以指定可用方法，有效的请求正文，潜在的响应代码，响应正文等。然后，开发人员将其编入她正在建立的客户。

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