REST WebServices - 接受 JSON 但返回 XML 是一种好的做法还是一般做法，反之亦然？

Question

我发现向 Google 正确提出我的问题有点困难。

我正在构建一个 REST Web 服务，它可以接受和返回 XML 和 JSON 媒体类型。我的客户可以使用Content-Type 标头决定向我的服务发送什么（如果是POST），以及使用Accept 标头作为响应接收什么。

但是，我的问题是，我能否创建一个 Web 服务，使其只能接受 JSON（即客户端必须设置Content-type=application/json），但该服务可以返回 XML仅（客户端必须设置Accept=application/xml）？

虽然这在技术上是可行的，但我想知道这是否是一种好的做法，是否有任何 REST Web 服务的通用实现，其中客户端可以指定特定的 Content-Type 但不同的 Accept 标头。

假设我已经实现了如下所示的服务：

@POST
@Path("/users")
@Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
public User createUser(User user) {
     /* Do something */
     return user;
}

在上述情况下，客户端可以将 Post 数据以 JSON 格式发送，但期望以 XML 格式接收响应，反之亦然。

这真的是一个好习惯吗？ REST 服务是否应该或不应该强调返回具有与其接受的相同媒体类型的内容？比如，消费application/xml时产生application/xml，消费application/json时产生application/json等等？

Answer 1

虽然技术上可行，但这根本不是一个好的做法，尤其是如果客户端通过其Accept 标头明确声明它只接受application/json。

您可以在同一路径上创建两种方法，而不是一种方法同时接受 XML 和 JSON，每种方法专用于一种特定的内容类型：

@POST
@Path("/users")
@Consumes({MediaType.APPLICATION_JSON})
@Produces({MediaType.APPLICATION_JSON})
public User createUserJson(User user) {
     /* Do something */
     return user;
}

@POST
@Path("/users")
@Consumes({MediaType.APPLICATION_XML})
@Produces({MediaType.APPLICATION_XML})
public User createUserXml(User user) {
     /* Do something */
     return user;
}

另见Accept header spec in RFC2616