Search results

More about YAML

When you created the OpenAPI specification, you usually use a syntax called YAML. The file extension can be either “.yaml” or “.yml.” (You can also use JSON, but the prevailing trend with the OpenAPI document format is YAML.) YAML stands for “YAML Ain’t Markup Language.” This means that the YAML syntax doesn’t have markup tags such as < or >. Instead, it uses colons to denote an object’s properties and hyphens to denote an array.

Working with YAML

YAML is easier to work with because it removes the brackets, curly braces, and commas that get in the way of reading content.

The YAML site itself is written using YAML, which you can immediately see is not intended for coding web pages.

YAML is an attempt to create a more human readable data exchange format. It’s similar to JSON (JSON is actually a subset of YAML) but uses spaces, colons, and hyphens to indicate the structure.

Many computers ingest data in a YAML or JSON format. It’s a syntax commonly used in configuration files and an increasing number of platforms (like Jekyll), so it’s a good idea to become familiar with it.

YAML is a superset of JSON

YAML and JSON are practically different ways of structuring the same data. Dot notation accesses the values the same way. For example, the Swagger UI can read the openapi.json or openapi.yaml files equivalently. Pretty much any parser that reads JSON will also read YAML. However, some JSON parsers might not read YAML, because there are a few features YAML has that JSON lacks (more on that later).

YAML syntax

With a YAML file, spacing is significant. Each two-space indent represents a new level:


Each new level is an object. In this example, the level1 object contains the level2 object, which contains the level3 object.

With YAML, you generally don’t use tabs (since they’re non-standard). Instead, you space twice.

Each level can contain either a single key-value pair (also referred to as a dictionary) or a sequence (a list of hyphens):

      itema: "one"
      itemameta: "two"
      itemb: "three"
      itembmeta: "four"

The values for each key can optionally be enclosed in quotation marks or not. If your value has something like a colon or quotation mark in it, you’ll want to enclose it in quotation marks. And if there’s a double quotation mark, enclose the value in single quotation marks, or vice versa.

Comparing JSON to YAML

Earlier in the course, we looked at various JSON structures involving objects and arrays. Here let’s look at the equivalent YAML syntax for each of these same JSON objects.

You can use to make the conversion from JSON to YAML or YAML to JSON.

Here are some key-value pairs in JSON:


Here’s the same thing in YAML syntax:

key1: value1
key2: value2

These key-value pairs are also called dictionaries.

Here’s an array (list of items) in JSON:

["first", "second", "third"]

In YAML, the array is formatted as a list with hyphens:

- first
- second
- third

Here’s an object containing an array in JSON:

"children": ["Avery","Callie","lucy","Molly"],
"hobbies": ["swimming","biking","drawing","horseplaying"]

Here’s the same object with an array in YAML:

  - Avery
  - Callie
  - lucy
  - Molly
  - swimming
  - biking
  - drawing
  - horseplaying

Here’s an array containing objects in JSON:


Here’s the same array containing objects converted to YAML:

    name: Tom
    age: 39
    name: Shannon
    age: 37

Hopefully by seeing the syntax side by side, it will begin to make more sense. Is the YAML syntax more readable? It might be difficult to see in these simple examples.

JavaScript uses the same dot notation techniques to access the values in YAML as it does in JSON. (They’re pretty much interchangeable formats.) The benefit to using YAML, however, is that it’s more readable than JSON.

However, YAML is more tricky sometimes because it depends on getting the spacing just right. Sometimes that spacing is hard to see (especially with a complex structure), and that’s where JSON (while maybe more cumbersome) is maybe easier to troubleshoot.

Some features of YAML not present in JSON

YAML has some features that JSON lacks.

You can add comments in YAML files using the # sign.

YAML also allows you to use something called “anchors.” For example, suppose you have two definitions that are similar. You could write the definition once and use a pointer to refer to both:

api: &apidef Application programming interface
application_programming_interface: *apidef

If you access the value (e.g., yamlfile.api or yamlfile.application_programming_interface), the same definition will be used for both. The *apidef acts as an anchor or pointer to the definition established at &apidef.

For details on other differences, see Learn YAML in Minutes. To learn more about YAML, see this YAML tutorial.

84% Complete

84/101 pages complete. Only 17 more pages to go...


Would you like to help encourage more content development and updates? If so, click the Donate button below to donate $10 through Paypal.

Get new posts delivered straight to your inbox.

Subscriber count: 4,285