Spore.RAML

---

Reference

This module allows to use a RESTful API Modeling Language document as a SPORE specification.

LIMITATION : inheritance of resources & traits is not supported.

LIMITATION : librairies and their inclusion are not supported.

This module requires lyaml (YAML 1.1).

Global Functions

new_from_raml( desc, [, { options }] )

Instanciate a ReST client from a RAML document defined by an URL or a filename.

The optional table options allows to overwrite some parameters of the description (see Spore.new_from_spec).

local raml = require 'Spore.RAML'
local client = wadl.new_from_raml 'helloworld.raml'

convert( raml )

Converts a RAML document into a SPORE specification (both are represented by a table).

Utilities

raml2spore url

Converts a RAML document into a Spore Specification. By this way, the SPORE specification could be edited/modified before use.

$ raml2spore helloworld.raml > helloworld.json

Examples

Not yet.