krishahn / raml-spec

RAML Specification

Home Page:http://raml.org/spec.html

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

The RESTful API Modeling Language (RAML) Spec

Note - Updated version

The RAML Workgroup is currently working on a newer version of the specification. All progress can be monitored inside the raml-10 branch. Please switch to that branch for any information about RAML 1.0.

###Licensing

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 submit issues in this repository to contribute to the evolution of the RAML specification.

Logos

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

ezoic increase your site revenue

About

RAML Specification

http://raml.org/spec.html