Example of a RAML description for a REST API dealing with songs.

0.8_spec

#%RAML 0.8
title: World Music API
baseUri: http://example.api.com/{version}
version: v1   
traits:                                 
  - paged:
      queryParameters:
        pages:
          description: The number of pages to return
          type: number
  - secured: !include http://raml-example.com/secured.yml
/songs:
  is: [ paged, secured ]
  get:
    queryParameters:
      genre:
        description: filter the songs by genre
  post:
  /{songId}:
    get:
      responses:
        200:face
          body:
            application/json:
              schema: |
                { "$schema": "http://json-schema.org/schema",
                  "type": "object",
                  "description": "A canonical song",
                  "properties": {
                    "title":  { "type": "string" },
                    "artist": { "type": "string" }
                  },
                  "required": [ "title", "artist" ]
                }
            application/xml:
    delete:
      description: |
        This method will *delete* an **individual song**"

ast

module AST

type RamlDef = {
  version : float
}

ramlversion

#%RAML 0.8

run

open FParsec
open AST
open parser

match run parser.raml "#%RAML 0.8" with
| Success raml,_,_ -> printfn "success"
| Failure errorStr,ex,state -> printrn "failure :("

versionString_1

open FParsec

let versionSentinel = skipString "#%RAML"

versionString_2

open FParsec

let versionSentinel = skipString "#%RAML"
let advanceToEOL = restOfLine true
let ramlVer = versionSentinel .>> ws >>. pfloat .>> advanceToEOL

versionString_final

open FParsec
open AST

let versionSentinel = skipString "#%RAML"
let advanceToEOL = restOfLine true
let ramlVer = versionSentinel .>> ws >>. pfloat .>> advanceToEOL

let makeRamlDef version = 
  {
    version = version
  }

let raml = ramlVer |>> makeRamlDef