Revision history [back]

The process of defining response header values in a Spring Boot REST service method involves the following steps:

1. Import the necessary packages: First of all, you need to import the necessary packages related to HTTP response headers. In most cases, you will need to import javax.servlet.http.HttpServletResponse.

2. Define the method signature: Define the method signature of your REST service method. This should include the necessary parameters, such as the input data, any path variables or query parameters, and the HttpServletResponse object.

3. Set the header value: Use the setHeader() method of the HttpServletResponse object to set the value of the desired header. This method takes two parameters: the name of the header, and the value you want to set.

4. Return the response: Finally, return the response object back to the client. In Spring Boot, you can usually do this by returning the desired value from your service method, and using Spring's built-in ResponseEntity object to wrap it and set any additional headers.

For example, the following code snippet shows how to set the Cache-Control header to no-cache in a Spring Boot REST service method:

@GetMapping("/my-endpoint")
public ResponseEntity<String> getMyData(HttpServletRequest request, HttpServletResponse response) {
    // set the Cache-Control header to no-cache
    response.setHeader("Cache-Control", "no-cache");

    // return the data to the client
    String myData = "Hello, world!";
    return ResponseEntity.ok(myData);
}