Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

15.15. YAML Provider

RESTEasy comes with built in support for YAML using the SnakeYAML library. To enable YAML support, you must insert the following dependencies into the project pom file of your application: Copy to Clipboard Toggle word wrap 
<dependency>
	<groupId>org.jboss.resteasy</groupId>
	<artifactId>resteasy-yaml-provider</artifactId>
	<version>${version.org.jboss.resteasy}</version>
	<scope>provided</scope>
</dependency>

<dependency>
	<groupId>org.yaml</groupId>
	<artifactId>snakeyaml</artifactId>
	<version>${version.org.yaml.snakeyaml}</version>
</dependency>
YAML provider recognizes three mime types:
  • text/x-yaml
  • text/yaml
  • application/x-yaml
The following example demonstrates how to use YAML in a resource method: Copy to Clipboard Toggle word wrap 
import javax.ws.rs.Consumes;
 import javax.ws.rs.GET;
 import javax.ws.rs.Path;
 import javax.ws.rs.Produces;

 @Path("/yaml")
 public class YamlResource
 {

@GET
@Produces("text/x-yaml")
public MyObject getMyObject() {
   return createMyObject();
}
...
 }
Report a bug
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat, Inc.