Generate an API mock service from a RAML definition using Osprey. This implementation was heavely influenced by MuleSoft's Osprey Mocking Service.
npm install -g raml-mock-service
Start the service from the CLI. This will automatically use the baseUri as the path to the mock service. For example, http://example.com/api will result in http://localhost:{PORT}/api.
raml-mock-service -f api.raml -p 3000
Options
-fPath to the root RAML definition (E.g./path/to/api.raml)-pPort number to bind the server locally
npm install raml-mock-service --save
The mocking service simply accepts a RAML definition and returns a router that can be mounted into any Connect-style middleware layer or even used with http. Best used with osprey to support incoming validation automatically.
var mockService = require('../raml-mock-service')
var express = require('express')
var parser = require('raml-1-parser')
var path = require('path')
var osprey = require('osprey')
var app = express()
parser.loadRAML(path.join(__dirname, 'api.raml'), { rejectOnErrors: true })
.then(function (ramlApi) {
var raml = ramlApi.expand(true).toJSON({ serializeMetadata: false })
app.use(osprey.server(raml))
app.use(mockService(raml))
app.listen(3000)
})createServerCreates a mock service instance with OspreycreateServerFromBaseUriCreates a mock service with Osprey and uses the base URI pathloadFileCreates a mock service with Osprey and the base URI path from a RAML file
This module only uses the example (or examples) property inside a given resource/method body. It does not take into consideration any of the example properties defined inside the properties or schema of the body itself.
Apache License 2.0