Alberto Zuin Network Specialist

RAML: a language for the API documentation

These days I’m in love with RAML, a programming language created to document effectively the API.

In fact, I am participating all’APIConUK, a three-day conference focused on the world of API. Among the many interesting talks (the days are very intense: five each day), one in particular caught my attention … and the case would have it, the one dedicated to RAML was just the first.

With RAML you can not only document your APIs, but also use some tools written in JavaScript and NodeJS and also released in OpenSource modes, that allow the user to access to the API documentation and test interactive realtime operation without having to go through tools as a generic REST Console, or even CURL.

The API editor for the producer and the console and the notebook dedicated to the consumer of the API can be used without installing anything on your servers, taking advantage of a public installation made ​​available by MuleSoft.

The syntax of Raml is very similar to YAML, so it is really easy and intuitive to write your own API documentation and the documentation on the official website is also really complete and intuitive.
We will start with header: