06: Spring 4 MVC RESTful GET & POST methods Web Services Tutorial

Posted on June 25, 2017 by

This tutorial extends Spring 4 MVC RESTful Web Service Beginner Tutorial step by step.

Controller that supports GET with path variable & POST methods

Step 1: The “AccountController.java” that has two additional methods to support requests like

GET: http://localhost:8080/simpleWeb/entry/v1/forecasting/account/123

POST: http://localhost:8080/simpleWeb/entry/v1/forecasting/account

package com.mytutorial.controller;
import java.math.BigDecimal;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
import com.mytutorial.model.Account;
@Controller
@RequestMapping("/v1/forecasting")
public class AccountController {
    @RequestMapping(value = "/accounts", method = RequestMethod.GET, produces={MediaType.APPLICATION_JSON_VALUE})
    public @ResponseBody Account[] getAccounts() {
        Account[] accounts = new Account[] { new Account("123", "John R", BigDecimal.valueOf(235.00)),
                new Account("345", "Peter J", BigDecimal.valueOf(2505.60)) };
        return accounts;
    }
    
    @RequestMapping(value = "/account/{id}", method = RequestMethod.GET, produces={MediaType.APPLICATION_XML_VALUE})
    public @ResponseBody Account getAccount(@PathVariable("id") String id) {
        //TODO: go to database and get the Account by id
        Account account = new Account(id, "John R", BigDecimal.valueOf(235.00));
        return account;
    }
    
    @RequestMapping(value = "/account", method = RequestMethod.POST)
    public ResponseEntity<Account> saveAccount(@RequestBody Account account) {
        System.out.println("Creating:" + account);
        //TODO: Save to database
        return new ResponseEntity<Account>(account, HttpStatus.OK);
    }
    
}

package com.mytutorial.controller;

import java.math.BigDecimal;

import org.springframework.http.HttpStatus;

import org.springframework.http.MediaType;

import org.springframework.http.ResponseEntity;

import org.springframework.stereotype.Controller;

import org.springframework.web.bind.annotation.PathVariable;

import org.springframework.web.bind.annotation.RequestBody;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestMethod;

import org.springframework.web.bind.annotation.ResponseBody;

import com.mytutorial.model.Account;

@Controller

@RequestMapping("/v1/forecasting")

public class AccountController {

@RequestMapping(value = "/accounts", method = RequestMethod.GET, produces={MediaType.APPLICATION_JSON_VALUE})

public @ResponseBody Account[] getAccounts() {

Account[] accounts = new Account[] { new Account("123", "John R", BigDecimal.valueOf(235.00)),

new Account("345", "Peter J", BigDecimal.valueOf(2505.60)) };

return accounts;

}

@RequestMapping(value = "/account/{id}", method = RequestMethod.GET, produces={MediaType.APPLICATION_XML_VALUE})

public @ResponseBody Account getAccount(@PathVariable("id") String id) {

//TODO: go to database and get the Account by id

Account account = new Account(id, "John R", BigDecimal.valueOf(235.00));

return account;

}

@RequestMapping(value = "/account", method = RequestMethod.POST)

public ResponseEntity<Account> saveAccount(@RequestBody Account account) {

System.out.println("Creating:" + account);

//TODO: Save to database

return new ResponseEntity<Account>(account, HttpStatus.OK);

}

Step 2: Package as simpleWeb.war and deploy to Tomcat’s “webapps” folder.

Step 3: Start the Tomcat server.

GET method with account id as a path variable

http://localhost:8080/simpleWeb/entry/v1/forecasting/account/123

<Account>
	<id>123</id>
	<name>John R</name>
	<balance>235.0</balance>
</Account>

</Account>

POST method

http://localhost:8080/simpleWeb/entry/v1/forecasting/account

POST method

XML sent via HTTP Request

<Account>
	<id>123</id>
	<name>John R</name>
	<balance>235.0</balance>
</Account>

</Account>

Use @RestController annotation instead of @Controller

By using “@RestController” you can eliminate the need for using “@ResponseBody” annotation and “ResponseEntity” as shown below.

package com.mytutorial.controller;
import java.math.BigDecimal;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import com.mytutorial.model.Account;
@RestController
@RequestMapping("/v1/forecasting")
public class AccountController {
    @RequestMapping(value = "/accounts", method = RequestMethod.GET, produces={MediaType.APPLICATION_JSON_VALUE})
    public  Account[] getAccounts() {
        Account[] accounts = new Account[] { new Account("123", "John R", BigDecimal.valueOf(235.00)),
                new Account("345", "Peter J", BigDecimal.valueOf(2505.60)) };
        return accounts;
    }
    
    @RequestMapping(value = "/account/{id}", method = RequestMethod.GET, produces={MediaType.APPLICATION_XML_VALUE})
    public Account getAccount(@PathVariable("id") String id) {
        //TODO: go to database and get the Account by id
        Account account = new Account(id, "John R", BigDecimal.valueOf(235.00));
        return account;
    }
    
    @RequestMapping(value = "/account", method = RequestMethod.POST)
    public Account saveAccount(@RequestBody Account account) {
        System.out.println("Creating:" + account);
        //TODO: Save to database
        return account;
    }
    
}

package com.mytutorial.controller;

import java.math.BigDecimal;

import org.springframework.http.MediaType;

import org.springframework.web.bind.annotation.PathVariable;

import org.springframework.web.bind.annotation.RequestBody;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestMethod;

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

import com.mytutorial.model.Account;

@RestController

@RequestMapping("/v1/forecasting")

public class AccountController {

@RequestMapping(value = "/accounts", method = RequestMethod.GET, produces={MediaType.APPLICATION_JSON_VALUE})

public Account[] getAccounts() {

Account[] accounts = new Account[] { new Account("123", "John R", BigDecimal.valueOf(235.00)),

new Account("345", "Peter J", BigDecimal.valueOf(2505.60)) };

return accounts;

}

@RequestMapping(value = "/account/{id}", method = RequestMethod.GET, produces={MediaType.APPLICATION_XML_VALUE})

public Account getAccount(@PathVariable("id") String id) {

//TODO: go to database and get the Account by id

Account account = new Account(id, "John R", BigDecimal.valueOf(235.00));

return account;

}

@RequestMapping(value = "/account", method = RequestMethod.POST)

public Account saveAccount(@RequestBody Account account) {

System.out.println("Creating:" + account);

//TODO: Save to database

return account;

}

The contents in this Java-Success are copyrighted and from EmpoweringTech pty ltd. The EmpoweringTech pty ltd has the right to correct or enhance the current content without any prior notice. These are general advice only, and one needs to take his/her own circumstances into consideration. The EmpoweringTech pty ltd will not be held liable for any damages caused or alleged to be caused either directly or indirectly by these materials and resources. Any trademarked names or labels used in this blog remain the property of their respective trademark owners. Links to external sites do not imply endorsement of the linked-to sites. Privacy Policy

Responsive WordPress Theme powered by CyberChimps

Top

06: Spring 4 MVC RESTful GET & POST methods Web Services Tutorial

Controller that supports GET with path variable & POST methods

GET method with account id as a path variable

POST method

Use @RestController annotation instead of @Controller

300+ Java Developer Interview Q&As

300+ Java Architect Interview Q&As

300+ Big Data Interview Q&As

800+ Java Interview Q&As

Reviews

Disclaimer