grunt-apimocker

grunt-apimocker

Runs apimocker server to return mock service responses to your front end.

Getting Started

This plugin requires Grunt ~0.4.2

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-apimocker --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-apimocker');

The "apimocker" task

Overview

In your project's Gruntfile, add a section named apimocker to the data object passed into grunt.initConfig().

grunt.initConfig({
  apimocker: {
    options: {
      wait : false,
      configFile: 'your-config.json'
    }
  }
});

Options

options.configFile

Set the path to your apimocker config.json file. Path can be absolute, or relative to the Gruntfile.

options.wait

Set the no exit mode. If wait is false, then the plugin depends on another plugin with no exit mode. If wait is true, then it will not exit after running. Default is false. Set to true if you want to keep the apimocker server running, and you don't have another long running server task in your Grunt config.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

0.0.1

Initial commit.

0.0.2

Added "wait" option to keep server up & running. Thanks @moro-programmer !