HttpMediaTypeNotSupportedException in Spring Boot

🎓 Top 15 Udemy Courses (80-90% Discount): My Udemy Courses - Ramesh Fadatare — All my Udemy courses are real-time and project oriented courses.

▶️ Subscribe to My YouTube Channel (178K+ subscribers): Java Guides on YouTube

▶️ For AI, ChatGPT, Web, Tech, and Generative AI, subscribe to another channel: Ramesh Fadatare on YouTube

Spring Boot applications leverage the Spring Web module to create robust and scalable web applications. However, when working with web requests, it's possible to encounter certain exceptions. One such exception is the HttpMediaTypeNotSupportedException. 

What is HttpMediaTypeNotSupportedException? 

HttpMediaTypeNotSupportedException is thrown when the client sends a request with a media type that is not supported by the application. This can happen, for instance, if your controller endpoint is expecting a request with content type application/json, but the client sends a request with content type text/xml. 

Here is the Exception Trace:

org.springframework.web.HttpMediaTypeNotSupportedException: Content type 'text/xml' not supported
    at org.springframework.web.servlet.mvc.method.annotation.AbstractMessageConverterMethodArgumentResolver.readWithMessageConverters(AbstractMessageConverterMethodArgumentResolver.java:239)
    at org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor.readWithMessageConverters(RequestResponseBodyMethodProcessor.java:157)
    at org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor.resolveArgument(RequestResponseBodyMethodProcessor.java:130)
    at org.springframework.web.method.support.HandlerMethodArgumentResolverComposite.resolveArgument(HandlerMethodArgumentResolverComposite.java:127)
    ... more

How to reproduce? 

Let's consider a simple Spring Boot controller:

@RestController
@RequestMapping("/api/greetings")
public class GreetingController {

    @PostMapping(consumes = MediaType.APPLICATION_JSON_VALUE)
    public ResponseEntity<String> greet(@RequestBody String name) {
        return ResponseEntity.ok("Hello, " + name);
    }
}

Call REST API:

Now, if you send a POST request to /api/greetings with the header Content-Type: text/plain, you'll encounter the exception.

Exception in the console:

Solutions

Specify Supported Media Types

Make it clear in your controller which media types are supported using the consumes attribute:

@PostMapping(consumes = MediaType.APPLICATION_JSON_VALUE)

Handle the Exception

Use Spring's @ExceptionHandler to catch the exception and provide a meaningful response:

@ExceptionHandler(HttpMediaTypeNotSupportedException.class)
public ResponseEntity<String> handleTypeNotSupported(HttpMediaTypeNotSupportedException e) {
    return ResponseEntity.badRequest().body("Content type not supported.");
}

Client Awareness

Ensure clients are aware of the expected content type. This often means updating API documentation or providing clear error messages for developers. 

Use Spring's ContentNegotiationConfigurer

You can further customize how media types are resolved using this in a configuration class.

Conclusion

Handling media types correctly is crucial in a web application to ensure seamless client-server interactions. The HttpMediaTypeNotSupportedException gives developers a clear signal that there's a mismatch, and handling it gracefully can make the development process smoother.

Related Spring Exceptions Posts

• BeanCreationException in Spring Boot
• BeanInstantiationException in Spring Boot
• BeanDefinitionStoreException in Spring
• DataIntegrityViolationException in Spring Boot
• Spring InvalidDataAccessApiUsageException
• NoHandlerFoundException in Spring Boot
• HttpMessageNotReadableException in Spring Boot
• HttpMediaTypeNotSupportedException in Spring Boot
• MethodArgumentNotValidException in Spring Boot
• NoUniqueBeanDefinitionException Spring Boot
• UnsatisfiedDependencyException in Spring Boot
• Unsatisfied Dependency in Spring Boot

My Top and Bestseller Udemy Courses. The sale is going on with a 70 - 80% discount. The discount coupon has been added to each course below:

Build REST APIs with Spring Boot 4, Spring Security 7, and JWT

🆕 High-Demand 80–90% OFF

[NEW] Learn Apache Maven with IntelliJ IDEA and Java 25

🆕 High-Demand 80–90% OFF

ChatGPT + Generative AI + Prompt Engineering for Beginners

🚀 Trending Now 80–90% OFF

Spring 7 and Spring Boot 4 for Beginners (Includes 8 Projects)

🔥 Bestseller 80–90% OFF
Available in Udemy for Business

Building Real-Time REST APIs with Spring Boot - Blog App

🔥 Bestseller 80–90% OFF
Available in Udemy for Business

Building Microservices with Spring Boot and Spring Cloud

🌟 Top Rated 80–90% OFF
Available in Udemy for Business

Java Full-Stack Developer Course with Spring Boot and React JS

🔥 Bestseller 80–90% OFF
Available in Udemy for Business

Build 5 Spring Boot Projects with Java: Line-by-Line Coding

🌟 Top Rated 80–90% OFF

Testing Spring Boot Application with JUnit and Mockito

🔥 Bestseller 80–90% OFF
Available in Udemy for Business

Spring Boot Thymeleaf Real-Time Web Application - Blog App

🔥 Bestseller 80–90% OFF
Available in Udemy for Business

Master Spring Data JPA with Hibernate

🔥 Bestseller 80–90% OFF
Available in Udemy for Business

Spring Boot + Apache Kafka Course - The Practical Guide

🎓 Student Favorite 80–90% OFF
Available in Udemy for Business

Java Testing: Mastering JUnit 5 Framework

🆕 New 80–90% OFF

Reactive Programming in Java: Spring WebFlux and Testing

🌟 Top Rated 80–90% OFF

Spring Boot + RabbitMQ Course - The Practical Guide

🌟 Top Rated 80–90% OFF
Available in Udemy for Business

Functional Programming in Java (Includes Java Collections)

🎓 Student Favorite 80–90% OFF

ChatGPT for Java Developers: Boost Your Productivity with AI

🚀 Trending Now 80–90% OFF