The rise of well designed API

The RAML (RESTful API Modeling Language) is a language to design and document software API; it is open, vendor-neutral, based on YAML 1.2 and JSON. When describe a RAML file:

  • it’s important to create RAML file with “.raml” extension
  • indentation is fundamental (use 4-spaces or tab as in yaml)
  • split resources among more RAML files to improve code-readability and re-use.

Each RAML file should have a specific and appropriate header as below

#%RAML 1.0 
title: Foo REST Services API using Data types
version: v1
protocols: [ HTTPS ]
mediaType: application/json


  • title: describe the API’s title, use this…

Alessio Grumiro

Passionate developer from Milan, with experience in Artificial Intelligence, Cloud, Mobile, Web, IoT, Big Data and Cooking!

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store