A grunt plugin that runs a series of benchmark tests and creates an html report


A grunt plugin based on the nodejs module api-benchmark that takes a config.json file like this, makes some performance tests to your api, and creates an html export like this:

Node version: 0.10.0 required

Build status:

This plugin requires Grunt ~0.4.1

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-api-benchmark --save-dev

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


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

  api_benchmark: {
    my_api: {
      options: {
        output: 'generated'
      files: {
        'report.html': 'config.json'

Type: String Default value: ``

The destination dir where to save the report file

Just specify the name of the output for each config. It supports multiple configurations. AnyFile.html as output will produce the html, AnyFile.json will just save the data in a json file.

Needs to be something like this.

Needs to be an object containing the Name and the base http url of your api

Needs to be an object containing your routes. Supports multiple verbs, data, headers, and everything. Look at here for the full documentation

Supports a lot of options. Look at here for the complete list.


For the latest updates and release information follow @matteofigus on twitter. Feel free to open new Issues in case of Bugs or Feature requests. Pull requests are welcome, possibly in new branches.

grunt test