The simplest way to design APIs

RESTful API Modeling Language (RAML) makes it easy to manage the whole API lifecycle from design to sharing. It's concise - you only write what you need to define - and reusable. It is machine readable API design that is actually human friendly.

Write once. Use many. Creative laziness encouraged.

homepage logos
RAML Console
design Build Test document Share

Use RAML to Design Your API

RAML lets you see what your API looks like as you design it, using easy to read plain text. Without having to write a single line of code you can not only perfect your API design, but also create a fully functional mock for customers, partners, or even your own internal engineers to review and build off of.

Use RAML to Build Your API

RAML enables developers and engineers to do what they do best – write code. No more guesswork or getting halfway through your API only to realize the design doesn’t work or is inconsistent. You can also reduce your time to market (and bug based headaches) by using the many tools available to help you generate the general structure of your API from your RAML files.

Use RAML to Test Your API

Most engineers hate writing unit tests. RAML lets you generate a majority of the tests by running a simple shell command. No more manual tests (although we certainly recommend creating your own), and even better – you can even use third party services such as API Fortress, API Science, Parasoft, Postman, and SmartBear for your testing needs.

Use RAML to Document Your REST API

Say goodbye to spending hours writing and maintaining API documentation. With RAML all of your documentation can be easily generated, letting you provide up-to-date documentation, all at the click of a button.

Use RAML to Share & Support Your API

What good is an API if nobody is using it? RAML helps you provide an even richer experience to your users, including dynamic walk-through examples with the API Notebook, SDKs for the most popular languages, and more.

Hundreds of Open Source Projects

RAML is backed by a large open source community providing hundreds of pre-built, customizable tools for all your RESTful API needs