RAML (software)

Content sourced from Wikipedia, licensed under CC BY-SA 3.0.

RAML stands for RESTful API Modeling Language. It’s a YAML-based way to describe APIs, covering the parts you need to build and use them: resources, operations (like GET or POST), parameters, and responses. RAML promotes reuse, discovery, and sharing of API designs, helping teams establish good practices.

RAML is designed with RESTful APIs in mind, but it doesn’t require every REST constraint (for example, it doesn’t enforce HATEOAS). It was first proposed in 2013 and is developed by the RAML Workgroup, with support from many technology leaders. RAML is a trademark of MuleSoft.

There’s broader interest in standardizing API descriptions. In 2015, the Linux Foundation started the OpenAPI Initiative to create common descriptions for HTTP APIs. Founding members include SmartBear, Google, IBM, and Microsoft, and Swagger contributed its spec to the effort. RAML and API Blueprint were also considered in this process.

RAML files use the .raml extension and YAML-style indentation to show structure. You can convert RAML to OpenAPI or API Blueprint using tools like APIMATIC, letting you work with different API gateways.