RAML - Yaml format

home edit

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

#178on PLDB

11Years Old

4kRepos

Download source code:

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

Homepage · Source Code · Docs

RAML Specification

Tags: yamlFormat
RAML is developed on GitHub and has 3,867 stars
There are at least 4,190 RAML repos on GitHub
Early development of RAML happened in https://github.com/raml-org
RAML is written in Markdown, JSON, YAML
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
1 PLDB concepts link to RAML: cloc

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**