README.md

RAML Mock-ups!

Features

• Uses json-schema-faker for accurate mocked responses.
• Uses refaker for resolving remote/local $refs.
• It's fully tested and coveraged.
• Has watch mode built-in.

Install raml-mockup globally:

$ npm install -g raml-mockup

Then starts a mock-server from your RAML:

$ raml-mockup src/api.raml -d src/schemas -f http://json-schema.org -r src/formats.js -p 5000 -w

Now you can make requests through the mocked-API:

$ http http://localhost:5000/path/to/resource

The better if you're using httpie.

Options

• --directory → Used with --fakeroot to resolve faked references through this directory.
• --fakeroot → BaseURI for references that will fake (i.e. http://json-schema.org).
• --statuses → Use custom statusCode(s) for all matched resources.
• --formats → CommonJS module-id or path for custom formats.
• --timeout → Timeout requests from remote dereferencing.
• --silent → Turns off the reporting through the STDOUT.
• --watch → Enables the watch mode for mock-server.
• --port → Custom port for mock-server.

Run raml-mockup -h to display all usage info.

queryParams

Use the following options for custom responses:

• _statusCode=200 → Force a specific statusCode if its available.
• _forceExample=true → Force defined resource-example if its available.

Issues?

Please open a ticket or feel free for contributing.