Moved Content Negotiation article code from spring-mvc-java to spring-mvc-basics

spring-mvc-basics/src/main/java/com/baeldung/model/Employee.java

@@ -0,0 +1,61 @@
+package com.baeldung.model;
+
+import javax.xml.bind.annotation.XmlRootElement;
+
+@XmlRootElement
+public class Employee {
+
+    private long id;
+    private String name;
+    private String contactNumber;
+    private String workingArea;
+
+    public Employee() {
+        super();
+    }
+
+    public Employee(final long id, final String name, final String contactNumber, final String workingArea) {
+        this.id = id;
+        this.name = name;
+        this.contactNumber = contactNumber;
+        this.workingArea = workingArea;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(final String name) {
+        this.name = name;
+    }
+
+    public long getId() {
+        return id;
+    }
+
+    public void setId(final long id) {
+        this.id = id;
+    }
+
+    public String getContactNumber() {
+        return contactNumber;
+    }
+
+    public void setContactNumber(final String contactNumber) {
+        this.contactNumber = contactNumber;
+    }
+
+    public String getWorkingArea() {
+        return workingArea;
+    }
+
+    public void setWorkingArea(final String workingArea) {
+        this.workingArea = workingArea;
+    }
+
+    @Override
+    public String toString() {
+        return "Employee [id=" + id + ", name=" + name + ", contactNumber=" + contactNumber + ", workingArea=" + workingArea + "]";
+    }
+
+}

spring-mvc-basics/src/main/java/com/baeldung/spring/web/config/WebConfig.java

@@ -3,7 +3,9 @@ package com.baeldung.spring.web.config;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.core.io.ClassPathResource;
+import org.springframework.http.MediaType;
 import org.springframework.web.servlet.ViewResolver;
+import org.springframework.web.servlet.config.annotation.ContentNegotiationConfigurer;
 import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 import org.springframework.web.servlet.view.InternalResourceViewResolver;
@@ -47,4 +49,19 @@ public class WebConfig implements WebMvcConfigurer {
         bean.setOrder(1);
         return bean;
     }
+
+    /**
+     * Spring Boot allows configuring Content Negotiation using properties
+     */
+    @Override
+    public void configureContentNegotiation(final ContentNegotiationConfigurer configurer) {
+        configurer.favorPathExtension(true)
+            .favorParameter(true)
+            .parameterName("mediaType")
+            .ignoreAcceptHeader(false)
+            .useRegisteredExtensionsOnly(false)
+            .defaultContentType(MediaType.APPLICATION_JSON)
+            .mediaType("xml", MediaType.APPLICATION_XML)
+            .mediaType("json", MediaType.APPLICATION_JSON);
+    }
 }

spring-mvc-basics/src/main/java/com/baeldung/web/controller/EmployeeController.java

@@ -0,0 +1,31 @@
+package com.baeldung.web.controller;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.ModelAttribute;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.ResponseBody;
+
+import com.baeldung.model.Employee;
+
+@Controller
+public class EmployeeController {
+
+    Map<Long, Employee> employeeMap = new HashMap<>();
+
+    @ModelAttribute("employees")
+    public void initEmployees() {
+        employeeMap.put(1L, new Employee(1L, "John", "223334411", "rh"));
+        employeeMap.put(2L, new Employee(2L, "Peter", "22001543", "informatics"));
+        employeeMap.put(3L, new Employee(3L, "Mike", "223334411", "admin"));
+    }
+
+    @RequestMapping(value = "/employee/{Id}",produces = { "application/json", "application/xml" }, method = RequestMethod.GET)
+    public @ResponseBody Employee getEmployeeById(@PathVariable final Long Id) {
+        return employeeMap.get(Id);
+    }
+}

spring-mvc-basics/src/main/resources/application.properties

@@ -1 +1,7 @@
-server.servlet.context-path=/spring-mvc-basics
+server.servlet.context-path=/spring-mvc-basics
+
+### Content Negotiation (already defined programatically)
+spring.mvc.pathmatch.use-suffix-pattern=true
+#spring.mvc.contentnegotiation.favor-path-extension=true
+#spring.mvc.contentnegotiation.favor-parameter=true
+#spring.mvc.contentnegotiation.parameter-name=mediaType

spring-mvc-basics/src/test/java/com/baeldung/web/controller/EmployeeControllerContentNegotiationIntegrationTest.java

@@ -0,0 +1,63 @@
+package com.baeldung.web.controller;
+
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.header;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.MediaType;
+import org.springframework.test.web.servlet.MockMvc;
+
+@SpringBootTest
+@AutoConfigureMockMvc
+public class EmployeeControllerContentNegotiationIntegrationTest {
+
+    @Autowired
+    private MockMvc mockMvc;
+
+    @Test
+    public void whenEndpointUsingJsonSuffixCalled_thenJsonResponseObtained() throws Exception {
+        this.mockMvc.perform(get("/employee/1.json"))
+            .andExpect(status().isOk())
+            .andExpect(header().string(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_UTF8_VALUE));
+    }
+
+    @Test
+    public void whenEndpointUsingXmlSuffixCalled_thenXmlResponseObtained() throws Exception {
+        this.mockMvc.perform(get("/employee/1.xml"))
+            .andExpect(status().isOk())
+            .andExpect(header().string(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_XML_VALUE));
+    }
+
+    @Test
+    public void whenEndpointUsingJsonParameterCalled_thenJsonResponseObtained() throws Exception {
+        this.mockMvc.perform(get("/employee/1?mediaType=json"))
+            .andExpect(status().isOk())
+            .andExpect(header().string(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_UTF8_VALUE));
+    }
+
+    @Test
+    public void whenEndpointUsingXmlParameterCalled_thenXmlResponseObtained() throws Exception {
+        this.mockMvc.perform(get("/employee/1?mediaType=xml"))
+            .andExpect(status().isOk())
+            .andExpect(header().string(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_XML_VALUE));
+    }
+
+    @Test
+    public void whenEndpointUsingJsonAcceptHeaderCalled_thenJsonResponseObtained() throws Exception {
+        this.mockMvc.perform(get("/employee/1").header(HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON_VALUE))
+            .andExpect(status().isOk())
+            .andExpect(header().string(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_UTF8_VALUE));
+    }
+
+    @Test
+    public void whenEndpointUsingXmlAcceptHeaderCalled_thenXmlResponseObtained() throws Exception {
+        this.mockMvc.perform(get("/employee/1").header(HttpHeaders.ACCEPT, MediaType.APPLICATION_XML_VALUE))
+            .andExpect(status().isOk())
+            .andExpect(header().string(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_XML_VALUE));
+    }
+}