Importing a RAML specification

Importing

File ▸ Import (Ctrl+I) then the .raml file. Both RAML 0.8 and RAML 1.0 are recognised.

What is imported

Element	What Restorm makes of it
The resource tree	Nested folders
Each method	An HTTP request
Parameters	Typed (string, number, enumeration…)
Types and documentation	The API documentation

Security

Only Basic and OAuth 2.0 pre-wire an Authorization header. The other schemes (Digest, Pass Through, OAuth 1.0, x-* schemes) are documented only.

Limitations

!includes are refused

An !include <path> or an !include <url> makes the import fail with an explicit message. That is deliberate: resolving an include means reading an arbitrary file from disk or firing a network call on the user’s behalf.

Resolve your includes upstream (produce a flattened RAML) then import.

Other limitations: external type references are not resolved, and uses: libraries / RAML fragments are not merged.