DATAREST-293 - Added new module to easily add a HAL browser to Spring Data REST apps.

Added a module that repackages the webjar version of the HAL browser. The repackaging is necessary to be able to control the exposure of the browser dynamically and prevent Spring Boot's auto-exposure of webjars from kicking in.

Tweaked BasePathAwareHandlerMapping to default the Accept header to the one defined in the configuration if none is present in the request or */* is given. This will make sure we default to a JSON dialect in case no header is set.

spring-data-rest-hal-browser/src/main/java/org/springframework/data/rest/webmvc/halbrowser/HalBrowser.java

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2015 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.rest.webmvc.halbrowser;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.data.rest.core.config.RepositoryRestConfiguration;
+import org.springframework.data.rest.webmvc.BasePathAwareController;
+import org.springframework.http.MediaType;
+import org.springframework.util.Assert;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.servlet.View;
+import org.springframework.web.servlet.view.RedirectView;
+
+/**
+ * Controller with a few convenience redirects to expose the HAL browser shipped as static content.
+ * 
+ * @author Oliver Gierke
+ * @soundtrack Miles Davis - So what (Kind of blue)
+ */
+@BasePathAwareController
+public class HalBrowser {
+
+	private static String BROWSER = "/browser";
+	public static String BROWSER_INDEX = BROWSER.concat("/index.html");
+
+	private final RepositoryRestConfiguration configuration;
+
+	/**
+	 * Creates a new {@link HalBrowser} for the given {@link RepositoryRestConfiguration}.
+	 * 
+	 * @param configuration must not be {@literal null}.
+	 */
+	@Autowired
+	public HalBrowser(RepositoryRestConfiguration configuration) {
+
+		Assert.notNull(configuration, "RepositoryRestConfiguration must not be null!");
+
+		this.configuration = configuration;
+	}
+
+	/**
+	 * Redirects requests to the API root asking for HTML to the HAL browser.
+	 * 
+	 * @return
+	 */
+	@RequestMapping(value = { "/", "" }, method = RequestMethod.GET, produces = MediaType.TEXT_HTML_VALUE)
+	public View index() {
+		return browser();
+	}
+
+	/**
+	 * Redirects to the actual {@code index.html}.
+	 * 
+	 * @return
+	 */
+	@RequestMapping(value = "/browser", method = RequestMethod.GET)
+	public View browser() {
+
+		String basePath = configuration.getBasePath().toString();
+		return new RedirectView(basePath.concat(BROWSER_INDEX).concat("#").concat(basePath));
+	}
+}

spring-data-rest-hal-browser/src/test/java/org/springframework/data/rest/webmvc/halbrowser/HalBrowserIntegrationTests.java

@@ -0,0 +1,129 @@
+/*
+ * Copyright 2015 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.rest.webmvc.halbrowser;
+
+import static org.hamcrest.CoreMatchers.*;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.rest.core.config.RepositoryRestConfiguration;
+import org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration;
+import org.springframework.hateoas.MediaTypes;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.MediaType;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.test.context.web.WebAppConfiguration;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
+import org.springframework.web.context.WebApplicationContext;
+import org.springframework.web.servlet.config.annotation.EnableWebMvc;
+
+/**
+ * Integration tests for {@link HalBrowser}.
+ *
+ * @author Oliver Gierke
+ * @soundtrack Miles Davis - Blue in green (Kind of blue)
+ */
+@RunWith(SpringJUnit4ClassRunner.class)
+@WebAppConfiguration
+@ContextConfiguration
+public class HalBrowserIntegrationTests {
+
+	static final String BASE_PATH = "/api";
+	static final String BROWSER_INDEX = "/browser/index.html";
+	static final String TARGET = BASE_PATH.concat(BROWSER_INDEX).concat("#").concat(BASE_PATH);
+
+	@Configuration
+	@EnableWebMvc
+	static class TestConfiguration extends RepositoryRestMvcConfiguration {
+
+		@Override
+		protected void configureRepositoryRestConfiguration(RepositoryRestConfiguration config) {
+			config.setBasePath(BASE_PATH);
+		}
+	}
+
+	@Autowired WebApplicationContext context;
+
+	MockMvc mvc;
+
+	@Before
+	public void setUp() {
+		this.mvc = MockMvcBuilders.webAppContextSetup(context).//
+				defaultRequest(get(BASE_PATH).accept(MediaType.TEXT_HTML)).build();
+	}
+
+	/**
+	 * @see DATAREST-293
+	 */
+	@Test
+	public void exposesJsonUnderApiRootByDefault() throws Exception {
+
+		mvc.perform(get(BASE_PATH).accept(MediaType.ALL)).//
+				andExpect(status().isOk()).//
+				andExpect(header().string(HttpHeaders.CONTENT_TYPE, is(MediaTypes.HAL_JSON.toString())));
+	}
+
+	/**
+	 * @see DATAREST-293
+	 */
+	@Test
+	public void redirectsToBrowserForApiRootAndHtml() throws Exception {
+
+		mvc.perform(get(BASE_PATH).accept(MediaType.TEXT_HTML)).//
+				andExpect(status().isFound()).//
+				andExpect(header().string(HttpHeaders.LOCATION, endsWith(TARGET)));
+	}
+
+	/**
+	 * @see DATAREST-293
+	 */
+	@Test
+	public void forwardsBrowserToIndexHtml() throws Exception {
+
+		mvc.perform(get(BASE_PATH.concat("/browser"))).//
+				andExpect(status().isFound()).//
+				andExpect(header().string(HttpHeaders.LOCATION, endsWith(TARGET)));
+	}
+
+	/**
+	 * @see DATAREST-293
+	 */
+	@Test
+	public void exposesHalBrowser() throws Exception {
+
+		mvc.perform(get(BASE_PATH.concat("/browser/index.html"))).//
+				andExpect(status().isOk()).//
+				andExpect(content().string(containsString("The HAL Browser")));
+	}
+
+	/**
+	 * @see DATAREST-293
+	 */
+	@Test
+	public void retrunsApiIfHtmlIsNotExplicitlyListed() throws Exception {
+
+		mvc.perform(get(BASE_PATH).accept(MediaType.APPLICATION_JSON, MediaType.ALL)).//
+				andExpect(status().isOk()).//
+				andExpect(header().string(HttpHeaders.CONTENT_TYPE, startsWith(MediaType.APPLICATION_JSON_VALUE)));
+	}
+}

spring-data-rest-hal-browser/src/test/resources/logback.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+
+	<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
+		<encoder>
+			<pattern>%d %5p %40.40c:%4L - %m%n</pattern>
+		</encoder>
+	</appender>
+
+	<logger name="org.springframework" level="warn" />
+
+	<root level="error">
+		<appender-ref ref="console" />
+	</root>
+
+</configuration>