The RESTful API Modeling Language (RAML) Spec

###Licensing Contributors License Agreement

Branding Guidelines

Index

###Introduction: RAML Overview
RAML Markup Language

####Includes

Named Parameters:

Named Parameters with Multiple Types

Basic Information:

Root
Base URI and baseUriParameters
Protocols
Default Media Type
Schemas
URI Parameters
User Documentation

Resources and Methods:

Resources and Nested Resources
Template URIs and URI Parameters Absolute URI
Query Parameters
Body
Web Forms

Schemas and Responses:

Schemas
Responses
Headers

Security:

Declaration
Type
OAuth 1.0
OAuth 2.0
Usage: Applying a Security Scheme to an API

###References: Normative References
Informative References

##Contributing

Please, follow these steps to contribute with the RAML Spec project:

• Check the Contributors License Agreement
• Fork this repository.
• Clone the forked repository.
• Apply the changes on master.
• Commit, Push.
• Generate Pull Request.

Please, follow these steps to accept a contribution

• Verify the Pull Request.
• If it's correct: Merge/Accept.
• Move to gh-pages branch (git checkout gh-pages) and run ./specs_publish.sh (this script copies the resulting raml-0.8.md file from master to the current branch gh-pages and places it in the following path: ./spec.md which is needed to have the specs published in the site). Note: This is a shell script, only working on UNIX based OS.

Logos

Download the RAML Logos in JPG and EPS format. ( for usage questions email info@raml.org ).