Spring Boot – Example of RESTful Web Service with XML Response

Spring boot services by default gives the response in JSON format, but we can reverse this functionality in such a way that the default response will be in XML.  In order to do that we have to add a new dependency called jackson-dataformat-xml.  With this dependency services by default gives the response in XML format and if you want to see the response in JSON, just append .json to the URL that’s it 🙂 I will show you with an example.

Dependency

<dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-xml</artifactId>
</dependency>

Final pom.xml

<project
    xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.java4s</groupId>
    <artifactId>SpringBootRestfulXML</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.6.RELEASE</version>
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- xml dependency-->
        <dependency>
            <groupId>com.fasterxml.jackson.dataformat</groupId>
            <artifactId>jackson-dataformat-xml</artifactId>
        </dependency>
        <!-- xml dependency end-->
    </dependencies>
    <properties>
        <java.version>1.8</java.version>
    </properties>
</project>

SpringBootApp.java

package com.java4s.app;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class SpringBootApp {
    public static void main(String[] args) {

        SpringApplication.run(SpringBootApp.class, args);

    }
}

application.properties

server.contextPath=/springbootrestxml

SpringJava4sController.java

package com.java4s.app.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import com.java4s.model.Customer;

@RestController
public class SpringJava4sController {

    @GetMapping(path = "/get-cust-info")
    public Customer customerInformation() {
        Customer cust = new Customer();

        cust.setCustNo(100);
        cust.setName("Bank of America");
        cust.setCountry("United States");

        return cust;
    }
}

Customer.java

package com.java4s.model;

public class Customer {

    private int custNo;
    private String name;
    private String country;

    public Customer() {

    }

    public Customer(int custNumber, String name, String country) {
        this.custNo = custNumber;
        this.name = name;
        this.country = country;
    }

    public int getCustNo() {
        return custNo;
    }

    public void setCustNo(int custNo) {
        this.custNo = custNo;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getCountry() {
        return country;
    }

    public void setCountry(String country) {
        this.country = country;
    }

}

Output

Run the application and hit http://localhost:8080/springbootrestxml/get-cust-info

If we want to see the response in JSON, append .json to the URL.. http://localhost:8080/springbootrestxml/get-cust-info.json

You Might Also Like

• Spring Boot Configure DataSource Using JNDI with Example
• How to Configure Cache in Spring Boot Applications
• Spring Boot – Display All Beans Available in ApplicationContext
• Spring Boot – RESTful Web Service with POST Request in XML Example
• Spring Boot – RESTful Web Service with POST Request in JSON Example

::. About the Author .::
		Siva Teja Reddy Kandula - Sr Software Developer - Java/J2EE Consultant Founder of Java4s - Get It Yourself, A popular Java/J2EE Programming Blog, Love Java and UI frameworks. You can sign-up for the Email Newsletter for your daily dose of Java tutorials.