Wednesday 7 August 2019

Spring boot REST: Send no content (response code 204)

You can use 'ResponseEntity<Void>(HttpStatus.NO_CONTENT)' to send no content response.

Example
@RequestMapping("/welcome")
public Object welcomeMe(@RequestParam(name = "userName") String name) {

    if (name == null || "none".equalsIgnoreCase(name)) {
        return new ResponseEntity<Void>(HttpStatus.NO_CONTENT);
    }
    return ResponseEntity.ok("Hello " + name);

}


Find the below working application.

App.java
package com.sample.app;

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

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

        SpringApplication.run(App.class, args);

    }
}


HomeController.java

package com.sample.app.cotroller;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HomeController {

    @RequestMapping("/")
    public String home() {
        return "Welcome to spring boot REST App development";
    }

    @RequestMapping("/welcome")
    public Object welcomeMe(@RequestParam(name = "userName") String name) {

        if (name == null || "none".equalsIgnoreCase(name)) {
            return new ResponseEntity<Void>(HttpStatus.NO_CONTENT);
        }
        return ResponseEntity.ok("Hello " + name);

    }

}


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>springRest</groupId>
    <artifactId>springRest</artifactId>
    <version>1</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
    </parent>

    <name>springbootApp</name>
    <url>http://maven.apache.org</url>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>
</project>


Total project structure looks like below.



Run App.java.

Open the url 'http://localhost:8080/welcome?userName=none' in browser, you will get 204 response code.


You can download complete working application from this link.

Previous                                                    Next                                                    Home

No comments:

Post a Comment