diff --git a/README.md b/README.md index 35ae5d1..82fca2a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -## Advanced API mocker +## Advanced API mocker Version 2 This is a connect.js middleware to mock http request with manual body, headers and status code. Used to mock REST API. @@ -20,6 +20,25 @@ middleware: function (connect, opt) { }); ``` +If don't want use gulp, you can use without +```javascript +var connect = require('connect'); +var http = require('http'); +var mocker = require('connect-api-mocker-adv') + +var app = connect(); + + var options = { + urlRoot: '/api', + pathRoot: 'mocks', + ignoreQuery: false + }; + +app.use(mocker(options)); + +http.createServer(app).listen(3000); +``` + Firstly mocks will be served, than other middleware. ## Structure @@ -130,6 +149,16 @@ Default: 0 (unlimited) Limit speed of response in KB +### options.ignoreQuery + +Type: `Boolean` + +Default: true + +If true querystring is ignored. + - If false - each mock folder will be checked for custom query string. + - Format of subfolders with query: #[parameterName[=parameterValue]] + diff --git a/package.json b/package.json index b6615c4..d8733f9 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "connect-api-mocker-adv", + "name": "connect-api-mocker-adv-v2", "version": "0.2.1", "description": "Middleware to mock connect request", "main": "index.js", @@ -16,9 +16,9 @@ }, "repository": { "type": "git", - "url": "git://github.com/maxaon/connect-api-mocker-adv.git" + "url": "git://github.com/sgulci/connect-api-mocker-adv.git" }, - "homepage": "https://github.com/maxaon/connect-api-mocker-adv", + "homepage": "https://github.com/sgulci/connect-api-mocker-adv", "dependencies": { "js-yaml": "^3.2.6", "lodash": "^3.2.0"