root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 15 Packages Projects Releases Wiki Activity

Polish "Update instructions on how to use JAXB as XML renderer" 

Closes gh-16005
This commit is contained in:
Stephane Nicoll 2019-02-26 16:57:47 +01:00
parent 221ff8d69f
commit c47edd15af
1 changed files with 11 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc
View File

@ -1154,15 +1154,9 @@ tend to send accept headers that prefer XML.
[[howto-write-an-xml-rest-service]] [[howto-write-an-xml-rest-service]]
=== Write an XML REST Service === Write an XML REST Service
If you have the Jackson XML extension (`jackson-dataformat-xml`) or JAXB on the classpath, you If you have the Jackson XML extension (`jackson-dataformat-xml`) on the classpath, you
can use it to render XML responses. The previous example that we used for JSON would can use it to render XML responses. The previous example that we used for JSON would
work. work. To use the Jackson XML renderer, add the following dependency to your project:
NOTE: To get the server to render XML instead of JSON, you might have to send an
`Accept: text/xml` header (or use a browser).
==== Jackson XML
To use the Jackson XML renderer, add the following dependency to your project:
[source,xml,indent=0,subs="verbatim,quotes,attributes"] [source,xml,indent=0,subs="verbatim,quotes,attributes"]
---- ----
@ -1172,10 +1166,9 @@ To use the Jackson XML renderer, add the following dependency to your project:
</dependency> </dependency>
---- ----
==== JAXB If Jackson's XML extension is not available and JAXB is available, XML can be rendered
If Jackson's XML extension is not available, JAXB is tried next, with the additional requirement of having `MyThing` annotated as `@XmlRootElement`, as
with the additional requirement of having `MyThing` annotated as shown in the following example:
`@XmlRootElement`, as shown in the following example:
[source,java,indent=0,subs="verbatim,quotes,attributes"] [source,java,indent=0,subs="verbatim,quotes,attributes"]
---- ----
@ -1186,7 +1179,8 @@ with the additional requirement of having `MyThing` annotated as
} }
---- ----
To use JAXB as XML renderer, add the following dependency to your project: JAXB is only available out of the box with Java 8. If you're using a more recent java
generation, add the following dependency to your project:
[source,xml,indent=0,subs="verbatim,quotes,attributes"] [source,xml,indent=0,subs="verbatim,quotes,attributes"]
---- ----
@ -1196,6 +1190,10 @@ To use JAXB as XML renderer, add the following dependency to your project:
</dependency> </dependency>
---- ----
NOTE: To get the server to render XML instead of JSON, you might have to send an
`Accept: text/xml` header (or use a browser).
[[howto-customize-the-jackson-objectmapper]] [[howto-customize-the-jackson-objectmapper]]
=== Customize the Jackson ObjectMapper === Customize the Jackson ObjectMapper