rest - 如何为 POST 端点创建链接关系？

Question

在构建我的 Web 服务的 RESTful API 时，我试图给客户 link relations ，例如(这是 GET 入口点返回的内容):

<doc>
 <links>
  <link rel="self" href="/home"/>
  <link rel="post" href="/post-new-article"/>
 </links>
</doc>

我希望客户了解，为了发布新文章，他必须向 /post-new-article 提交 POST 请求。与 "text"作为查询参数。

但我没有说什么 "POST"在文档中，我没有告诉他我期待哪个 HTTP 查询参数。我应该如何以及在哪里提供这些信息？是否有任何事实上的标准/约定？

Answer 1

技术上正确的答案是它由文档的媒体类型定义。例如，假设 API 提供 HTML。客户端是浏览器。

按照惯例，当用户代理(浏览器)访问资源(由 anchor 标记标识)时，它会发出 HTTP GET到服务 API 的服务器。假设一切按计划进行，服务器将返回该资源的另一个 HTML 表示。

同样，当用户代理提交表单时，它会发出 HTTP GET默认情况下，除非 method form 的属性标签表示应该 POST数据。 (详情here。)

您的 API 文档应详细指定您的 REST 服务使用的媒体类型。如果它是自定义类型，则规范应包括以下链接的规则。如果您的 API 通过 HTTP 运行，则规则将指定 GET , POST , DELETE等以及任何其他要求/约定。

来自罗伊本人:http://roy.gbiv.com/untangled/2008/rest-apis-must-be-hypertext-driven