<p>YAML is a recursive acronym for <em>Yaml ain't markup language</em>. It is generally considered easier to read than more verbose XML or JSON serialization languages.</p>
<blockquote>
<p><strong>Serialization</strong> is the process of translating a data structure or object state into a format that can be stored or transmitted and reconstructed later.</p>
</blockquote>
<p><code>YAML</code> is most often used for configuration files of servers and software applications. YAML files have an extension of .yaml or .yml. <a href="https://yaml.org/faq.html" target="_blank" rel="noopener">Yaml official site</a> recommends using <code>.yaml</code> extension whenever possible.</p>
<p>YAML syntax has python like indentation with nesting for representing hierarchical data. YAML is a superset of JSON, so every JSON data is a valid YAML but not vice-versa.</p>
<p>A sample YAML file looks like below.</p>
<pre class="language-yaml"><code>---
name: John
age: 25
hobbies:
  - swimming
  - dancing
  - programming</code></pre>
<p>YAML is used for config files in <a href="https://devapt.com/dynamodb-nodejs-crud" target="_blank" rel="noopener">AWS</a>, Docker, etc.</p>
<h2 style="text-align: center;">YAML syntax</h2>
<h3>Comments</h3>
<p>Unlike JSON, YAML allows having comments in the file. These comments can be inserted using a number sign(<code>#</code>). &nbsp;If <code>#</code> characters appear inside a string, then they are considered number sign <code>#</code>&nbsp;literals.</p>
<pre class="language-yaml"><code># This is a comment in yaml
name: John</code></pre>
<h3>Strings and numbers</h3>
<p>YAML supports various kinds of data types strings, numbers, boolean, arrays or lists, etc. The key-value pairs are separated with a colon followed by a space.</p>
<pre class="language-yaml"><code># Object(key-value pairs)
project: XYZ
version: 2.0</code></pre>
<p>It's optional to wrap strings with single or double-quotes. If there are any special characters or punctuation marks like colon(<code>:</code>) or dashes(<code>-</code>) in the strings then wrapping with quotes is recommended.</p>
<p>Tab characters are not allowed in YAML only whitespaces have to be used for indentation.&nbsp;</p>
<h3>Booleans</h3>
<p>The allowed boolean values are <code>true/false</code>, <code>yes/no</code>, <code>on/off</code></p>
<pre class="language-yaml"><code># Boolean value property
isOpenSource: true # equivalents &rarr; yes or on</code></pre>
<h3>Nesting key-value pairs</h3>
<p>The nesting of the key-value pairs is done by indenting the key-value pairs in the next line after the colon.</p>
<pre class="language-yaml"><code># Nested object(key-value pairs)
details:
  name: Server config
  service: abc
  state: started</code></pre>
<h3>Arrays or lists</h3>
<p>An array sequence starts with a dash(<code>-</code>) followed by a space and the indentation separates from the parent.&nbsp;</p>
<pre class="language-yaml"><code># Array of values
technologies:
  - SQL
  - GO
  - Javascript</code></pre>
<p>An array of objects(key-value pairs) can be written similarly just by indenting each key-value pair in reference to the dash(<code>-</code>).</p>
<pre class="language-yaml"><code># Array of objects
collaborators:
  - name: John
    age: 25
  - name: James
    age: 26</code></pre>
<h3>Multiline strings</h3>
<p>A pipe(<code>|</code>) character at the beginning of the string is used to have a string with multi-lines preserved without having to use any escape characters.</p>
<pre class="language-yaml"><code># Multiline strings
summary: |
  This is the first line of the string.
  This is the second and line break is preserved.</code></pre>
<p>When a greater than character(<code>&gt;</code>) is used at the beginning of the string then the multi-lines get wrapped by stripping leading indentations and trailing white spaces. This is good for writing the readable lines of strings without the need to preserve the line breaks.</p>
<pre class="language-yaml"><code># Folded text
description: &gt;
  This is a very very long text just wrapped
  in multi-lines but all this text is considered
  as a continuous text without any line breaks.</code></pre>
<h3>Document separator</h3>
<p>YAML allows having multiple documents in a single file by separating them with three hyphens(<code>---</code>).</p>
<pre class="language-yaml"><code>---
# A yaml document
project: XYZ</code></pre>
<h2 style="text-align: center;">YAML vs JSON</h2>
<p>The main aim of YAML is to make the data easily readable and understandable. Some of the major differences between YAML and JSON are:</p>
<table style="border-collapse: collapse; width: 100.006%; border-style: solid;" border="1">
<tbody>
<tr style="height: 23.7976px;">
<th style="width: 48.0477%; text-align: center; height: 23.7976px; border-style: solid; border-width: 2px;">YAML</th>
<th style="width: 48.0477%; text-align: center; height: 23.7976px; border-style: solid; border-width: 2px;">JSON</th>
</tr>
<tr style="height: 23.7976px;">
<td style="width: 48.0477%; vertical-align: top; text-align: left; height: 23.7976px; border-style: solid; border-width: 2px;">1. Easy to read and understand</td>
<td style="width: 48.0477%; vertical-align: top; text-align: left; height: 23.7976px; border-style: solid; border-width: 2px;">1. A bit difficult to read and understand</td>
</tr>
<tr style="height: 23.7976px;">
<td style="width: 48.0477%; vertical-align: top; text-align: left; height: 23.7976px; border-style: solid; border-width: 2px;">2. Uses nested indentation for hierarchy</td>
<td style="width: 48.0477%; vertical-align: top; text-align: left; height: 23.7976px; border-style: solid; border-width: 2px;">2. Uses braces and brackets for hierarchy</td>
</tr>
<tr style="height: 23.7976px;">
<td style="width: 48.0477%; vertical-align: top; text-align: left; height: 23.7976px; border-style: solid; border-width: 2px;">3. Comments are allowed</td>
<td style="width: 48.0477%; vertical-align: top; text-align: left; height: 23.7976px; border-style: solid; border-width: 2px;">3. No comments are allowed</td>
</tr>
<tr style="height: 23.7976px;">
<td style="width: 48.0477%; vertical-align: top; text-align: left; height: 23.7976px; border-style: solid; border-width: 2px;">4. Wrapping strings with quotes is optional</td>
<td style="width: 48.0477%; vertical-align: top; text-align: left; height: 23.7976px; border-style: solid; border-width: 2px;">4. Must wrap strings with double quotes</td>
</tr>
<tr style="height: 47.5952px;">
<td style="width: 48.0477%; vertical-align: top; text-align: left; height: 47.5952px; border-style: solid; border-width: 2px;">5. Multiple documents are allowed in a single file</td>
<td style="vertical-align: top; text-align: left; height: 47.5952px; border-style: solid; border-width: 2px;">5. Only one document per file</td>
</tr>
<tr style="height: 23.7976px;">
<td style="width: 48.0477%; vertical-align: top; text-align: left; height: 23.7976px; border-style: solid; border-width: 2px;">6. It's a superset of JSON</td>
<td style="width: 48.0477%; vertical-align: top; text-align: left; height: 23.7976px; border-style: solid; border-width: 2px;">6. Every JSON is a valid YAML</td>
</tr>
<tr style="height: 23.7976px;">
<td style="width: 48.0477%; vertical-align: top; height: 23.7976px; border-style: solid; border-width: 2px;">7. Mostly used for configuration files</td>
<td style="width: 48.0477%; vertical-align: top; height: 23.7976px; border-style: solid; border-width: 2px;">7. Mostly used for transmitting data</td>
</tr>
<tr>
<td style="width: 48.0477%; vertical-align: top; border-style: solid; border-width: 2px;">8. Python developers like this format</td>
<td style="width: 48.0477%; vertical-align: top; border-style: solid; border-width: 2px;">8. Javascript developers like this format</td>
</tr>
</tbody>
</table>
<p>Below is the similar kind of data represented in YAML and JSON formats.</p>
<h3>A typical YAML file</h3>
<pre class="language-yaml"><code>--- # YAML example
project: XYZ
version: 2.0
isOpenSource: true
technologies:
  - SQL
  - GO
  - Javascript
collaborators:
  - name: John
    age: 25
  - name: James
    age: 26
details:
  name: Server config
  service: abc
  state: started
summary: |
  This is the first line of the string.
  This is the second and line break is preserved.
description: &gt;
  This is a very very long text just wrapped
  in multi-lines but all this text is considered
  as a continuous text without any line breaks.</code></pre>
<h3>The equivalent JSON file&nbsp;</h3>
<pre class="language-json"><code>{
    "project": "XYZ",
    "version": 2,
    "isOpenSource": true,
    "technologies": [
        "SQL",
        "GO",
        "Javascript"
    ],
    "collaborators": [
        {
            "name": "John",
            "age": 25
        },
        {
            "name": "James",
            "age": 26
        }
    ],
    "details": {
        "name": "Server config",
        "service": "abc",
        "state": "started"
    },
    "summary": "This is the first line of the string.\nThis is the second and line break is preserved.\n",
    "description": "This is a very very long text just wrapped in multi-lines but all this text is considered as a continuous text without any line breaks\n"
}</code></pre>
<p>YAML also has a few more features like node anchors, references etc.&nbsp; But all the above-discussed features are the essential ones to know in YAML. There are YAML linting tools to validate the YAML files which you can use to validate your files.</p>
<p>That's all about YAML and its comparison with JSON.</p>

YAML is a human-readable serialization language similar to XML and JSON. Here are all you need to know about the YAML syntax and comparisons with JSON

Posts tagged with YAML

What is YAML? Learn YAML syntax & yaml vs json differences