25 lines
4.0 KiB
HTML
25 lines
4.0 KiB
HTML
<html><head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
|
<title>6. Serving Alternative Formats</title><link rel="stylesheet" type="text/css" href="css/manual-multipage.css"><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="multi_spring-cloud.html" title="Spring Cloud"><link rel="up" href="multi__spring_cloud_config.html" title="Part II. Spring Cloud Config"><link rel="prev" href="multi__spring_cloud_config_server.html" title="5. Spring Cloud Config Server"><link rel="next" href="multi__serving_plain_text.html" title="7. Serving Plain Text"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6. Serving Alternative Formats</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="multi__spring_cloud_config_server.html">Prev</a> </td><th width="60%" align="center">Part II. Spring Cloud Config</th><td width="20%" align="right"> <a accesskey="n" href="multi__serving_plain_text.html">Next</a></td></tr></table><hr></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="_serving_alternative_formats" href="#_serving_alternative_formats"></a>6. Serving Alternative Formats</h2></div></div></div><p>The default JSON format from the environment endpoints is perfect for
|
|
consumption by Spring applications because it maps directly onto the
|
|
<code class="literal">Environment</code> abstraction. If you prefer you can consume the same data
|
|
as YAML or Java properties by adding a suffix to the resource path
|
|
(".yml", ".yaml" or ".properties"). This can be useful for consumption
|
|
by applications that do not care about the structure of the JSON
|
|
endpoints, or the extra metadata they provide, for example an
|
|
application that is not using Spring might benefit from the simplicity
|
|
of this approach.</p><p>The YAML and properties representations have an additional flag
|
|
(provided as a boolean query parameter <code class="literal">resolvePlaceholders</code>) to
|
|
signal that placeholders in the source documents, in the standard
|
|
Spring <code class="literal">${…​}</code> form, should be resolved in the output where possible
|
|
before rendering. This is a useful feature for consumers that don’t
|
|
know about the Spring placeholder conventions.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/note.png"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>there are limitations in using the YAML or properties formats,
|
|
mainly in relation to the loss of metadata. The JSON is structured as
|
|
an ordered list of property sources, for example, with names that
|
|
correlate with the source. The YAML and properties forms are coalesced
|
|
into a single map, even if the origin of the values has multiple
|
|
sources, and the names of the original source files are lost. The YAML
|
|
representation is not necessarily a faithful representation of the
|
|
YAML source in a backing repository either: it is constructed from a
|
|
list of flat property sources, and assumptions have to be made about
|
|
the form of the keys.</p></td></tr></table></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="multi__spring_cloud_config_server.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="multi__spring_cloud_config.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="multi__serving_plain_text.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">5. Spring Cloud Config Server </td><td width="20%" align="center"><a accesskey="h" href="multi_spring-cloud.html">Home</a></td><td width="40%" align="right" valign="top"> 7. Serving Plain Text</td></tr></table></div></body></html> |