JarCastingWarning header for Spring Web MVC
Spring Warning Response is a library that makes it easy to return Warning header describes on RFC7234 responses from a Spring application.
This library works around a single annotation @ResponseWarning that you can put over every controller methods.
Installation
Add the following dependency to your project:
<dependency>
<groupId>com.kakawait</groupId>
<artifactId>spring-response-warning</artifactId>
<version>${spring-response-warning.version}</version>
</dependency>
Configuration
With Spring-boot (autoconfiguration)
Nothing for Spring-boot application, autoconfiguration will do the job for you.
Without Spring-boot
Simply register ResponseWarningHandlerInterceptor
@Configuration
public class WebMvcConfiguration extends WebMvcConfigurerAdapter {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new ResponseWarningHandlerInterceptor());
}
}
Usage
Deprecating API sample:
@RestController
class ProductsController {
@ResponseWarning(
code = WarnCode.MISCELLANEOUS_PERSISTENT_WARNING,
text = "Deprecated API: use /{productId} instead.")
@RequestMapping(method = GET, value = "/get", produces = APPLICATION_JSON_VALUE)
@Deprecated
public Product getProduct_v0(@RequestParam(value = "id") String productId) {
return ...;
}
@RequestMapping(method = GET, value = "/{productId}", produces = APPLICATION_JSON_VALUE}
public Product getProduct_v1(String productId) {
return ...;
}
}
The following HTTP request will produce the corresponding response:
GET /products?id=123 HTTP/1.1
HTTP/1.1 200 Ok
Content-Type: application/json
Warning: 299 - "Deprecated API: use /{productId} instead."
...
Getting help
If you have questions, concerns, bug reports, etc., please file an issue in this repository's Issue Tracker.
Getting involved
To contribute, simply make a pull request and add a brief description (1-2 sentences) of your addition or change.