The simplest way to model APIs

Write once. Use many. Creative laziness encouraged.

RAML 1.0 Specification

A simple but powerful syntax for modelling APIs

RAML enables rapid development of APIs using an approachable syntax
which can scale from hobby project to enterprise application

Name your API, specify its version and base URL

Specify reusable types to avoid duplication and redundancy

Model your endpoints with access information, HTTP verbs, parameters, example responses and more

Model multiple response types including JSON & XML within a single interface

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.

Learn More

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.

Learn More

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.

Learn More

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.

Learn More

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.

Learn 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

There are many advantages to taking an API-first development approach. And with the help of tools like RAML, APIs have become more elastic and easier to use.

Jerry Weng

Co-founder, CHOCOLABS