RAML - Yaml format

home code menu_book edit

RAML, aka RESTful API Modeling Language, is an open source yaml format created in 2013.

Source code:

git clone https://github.com/raml-org/raml-spec

#240on PLDB

11Years Old

4kRepos

RAML Specification

RAML website
RAML is developed on GitHub and has 3,780 stars
RAML docs
There are at least 4,190 RAML repos on GitHub
RAML first developed in https://github.com/raml-org
file extensions for RAML include raml
The Google BigQuery Public Dataset GitHub snapshot shows 416 users using RAML in 472 repos on GitHub
RAML LSP implementation
GitHub supports syntax highlighting for RAML

Example from Linguist:

#%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:
          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**