Top 1,000 Features Creators Events Podcasts Extensions Blog Explorer CSV Download

RAML

< >

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

#168on PLDB 11Years Old 4kRepos
Download source code:
git clone https://github.com/raml-org/raml-spec

RAML Specification


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

View source

- Build the next great programming language About Resources Acknowledgements Part of the World Wide Scroll