concept Markdown in category swagger

This is an excerpt from Manning's book Designing APIs with Swagger and OpenAPI MEAP V04. Login to get full access to this book.

8.3  Writing the description in Markdown

In this section we’re going to learn about Markdown and how to use it to create a rich text description of the FarmStall API. The rich text will go under the info.description field in the API definition.

Markdown is an amazing syntax that allows us to create rich text which can be rendered to HTML. It is far friendlier to write compared to HTML and is simple enough to use.

We’re going to flesh it out with Markdown and transform it into this…

Figure 8.5. Rich text description of FarmStall API

Rich text usually consists of italic, headers, lists, links, etc. Knowing how to write Markdown is becoming a must for developers from all walks of life! It is perhaps the most straight forward way to lift plain text into rich text, and is used in many different environments and supported by a host of platforms. You’ll find it in blogging/cms platforms, wiki pages, chatting apps and most places that rich text is desired.