Question

我已经将一个响应POST请求的API放在一起，方法是将新资源的内容放在响应正文中，并将新资源的URL放在Location HTTP响应头中。

示例请求

POST /api/v1/widgets HTTP/1.1
Content-type: application/json;
Accept: application/json;

{
    "name": "hugo@example.com",
    "price": "10",
}

示例回复：

HTTP 201 Created
Location: http://example.com/api/v1/widgets/123456

{
    'widget': 
    {
        'id': "123456",
        'created': "2012-06-22T12:43:37+0100",
        'name': "hugo@example.com",
        'price': "10",
    },
}

有人提出了一个问题，即网址也应该在响应正文中。这是最好的做法吗？

Answer 1

有理由不将新创建的资源的位置（URL）放在正文中：URL是服务使用者和服务之间消息交互所需的元数据，它不是＆＃34;业务数据＆＃34;。有一个名为"Messaging Metadata"的SOA设计模式，它建议URL，安全凭证，关联标识符，事务ID以及其他消息和组合上下文数据应放在标题中，而不是放在消息正文中。实际上，http已经提供了标准的头位置。

OTOH，如果您的REST服务使用HATEOAS，则响应可能包含一个或多个URL，这些URL是您希望为消费者提供动态绑定和调用的操作的直接链接。

我认为在标题和正文中都有URL是最糟糕的解决方案。从长远来看，冗余数据容易出现不一致。

Answer 2

我会把它放在标题中（作为位置：http://blah.blah.com/blah）。如果你想要的话，你也可以把它放在你的身体里（以你发送的任何适当的格式），这样就不合适了。

atompub REST API通常是良好REST API的良好参考。他们把它放在两者中。

HTTP/1.1 201 Created
Date: Fri, 7 Oct 2005 17:17:11 GMT
Content-Length: nnn
Content-Type: application/atom+xml;type=entry;charset="utf-8"
Location: http://example.org/edit/first-post.atom
ETag: "c180de84f991g8"  

<?xml version="1.0"?>
<entry xmlns="http://www.w3.org/2005/Atom">
  <title>Atom-Powered Robots Run Amok</title>
  <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id>
  <updated>2003-12-13T18:30:02Z</updated>
  <author><name>John Doe</name></author>
  <content>Some text.</content>
  <link rel="edit"
      href="http://example.org/edit/first-post.atom"/>
</entry>

REST响应 - 我应该将新资源的URL放在标题，正文还是两者中？

2 个答案: