在JSON中禁用超文本应用程序语言(HAL)？

Question

在版本2.0.2.RELEASE中使用带有JPA的Spring Data REST.

如何在JSON中禁用超文本应用程序语言(HAL)？http://stateless.co/hal_specification.html

我已经尝试了很多东西,但无济于事.例如,我已将Accept和Content-type标头设置为"application/json"而不是"application/hal + json",但我仍然收到带有超链接的JSON内容.

例如,我想得到类似的东西:

{
"name" : "Foo",
"street" : "street Bar",
"streetNumber" : 2,
"streetLetter" : "b",
"postCode" : "D-1253",
"town" : "Munchen",
"country" : "Germany",
"phone" : "+34 4410122000",
"vat" : "000000001",
"employees" : 225,
"sector" : {
     "description" : "Marketing",
     "average profit": 545656665,
     "average employees": 75,
     "average profit per employee": 4556
     }
}

代替:

{
"name" : "Foo",
"street" : "street Bar",
"streetNumber" : 2,
"streetLetter" : "b",
"postCode" : "D-1253",
"town" : "Munchen",
"country" : "Germany",
"phone" : "+34 4410122000",
"vat" : "000000001",
"employees" : 225,
"_links" : {
     "self" : {
          "href" : "http://localhost:8080/app/companies/1"
     },
     "sector" : {
          "href" : "http://localhost:8080/app/companies/1/sector"
     }
}
}

谢谢你的帮助.

Answer 1

(超)媒体类型

Spring Data REST的默认设置使用HAL作为默认的超媒体表示格式,因此服务器将为给定的Accept标头返回以下内容:

• 没有标题 - > application/hal+json- > HAL
• application/hal+json- > application/hal+json- >哈尔
• application/json- > application/json- > HAL(这是默认配置)
• application/x-spring-data-verbose+json- > application/x-spring-data-verbose+json- > Spring Data特定格式(links用于链接容器和content集合项的包装器).

如果配置RepositoryRestConfiguration.setDefaultMediaType(…)为非HAL格式,则服务器将返回特定于Spring Data的JSON格式,除非您明确要求application/hal+json.不可否认,配置选项可能有点误导,所以我提交了DATAREST-294以改进这一点.这个问题在2.1 RC1(Dijkstra)2014中得到了解决.

请注意,我们实际上需要一种超媒体格式,以便能够表达托管资源之间的关系并实现服务器的可发现性.所以你无法完全摆脱它.这主要是因为如果您公开具有双向关系的实体或构成一个巨大的对象图,您可能很容易崩溃服务器.

内联相关实体

如果您从不希望将扇区链接到并始终内联它们,那么一个选项就是首先将其SectorRepository从导出为REST资源中排除.您可以通过使用注释存储库接口来实现此目的@RepositoryRestResource(exported = false).

要在下面的示例中发布返回的表示,请查看Spring Data REST 2.1 M1中引入的投影功能.它基本上允许您通过简单的接口在资源上创建可以与默认视图不同的视图.

你基本上定义了一个接口:

@Projection(name = "foo", types = YourDomainClass.class)
interface Inlined {

  // list all other properties

  Sector getSector();
}

如果您将此接口放入域类的(子)包中或通过RepositoryRestConfiguration.projectionConfiguration()资源手动注册它,YourDomainClass则接受请求参数,projection以便foo在此示例中传入将根据需要呈现内联表示.

此提交通常具有关于该功能的更多信息,此提交具有定义的示例投影.