Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matteofigus/grunt-api-benchmark
api-benchmark grunt wrapper
https://github.com/matteofigus/grunt-api-benchmark
Last synced: 23 days ago
JSON representation
api-benchmark grunt wrapper
- Host: GitHub
- URL: https://github.com/matteofigus/grunt-api-benchmark
- Owner: matteofigus
- License: mit
- Created: 2013-10-26T00:23:22.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2018-06-04T01:11:47.000Z (over 6 years ago)
- Last Synced: 2024-11-20T17:06:57.727Z (about 1 month ago)
- Language: HTML
- Homepage:
- Size: 952 KB
- Stars: 46
- Watchers: 5
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
grunt-api-benchmark
=============
[](https://greenkeeper.io/)
> A grunt plugin based on the nodejs module [api-benchmark](https://github.com/matteofigus/api-benchmark) that takes a config.json file like [this](https://github.com/matteofigus/grunt-api-benchmark/blob/master/test/fixtures/input2.json), makes some performance tests to your api, and creates an html export like this:
Node version: **0.10.0** required
Build status: [](http://travis-ci.org/matteofigus/grunt-api-benchmark)
[](https://npmjs.org/package/grunt-api-benchmark)
## Getting Started
This plugin requires Grunt `^1.0.0`
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
```shell
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:
```js
grunt.loadNpmTasks('grunt-api-benchmark');
```
## The "api_benchmark" task
### Overview
In your project's Gruntfile, add a section named `api_benchmark` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
api_benchmark: {
my_api: {
options: {
output: 'generated'
},
files: {
'report.html': 'config.json'
}
}
}
});
```
### Options
#### options.output
Type: `String`
Default value: ``
The destination dir where to save the report file
### Files
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.
### The config file
Needs to be something like [this](https://github.com/matteofigus/grunt-api-benchmark/blob/master/test/fixtures/input2.json).
#### config.service
Needs to be an object containing the Name and the base http url of your api
#### config.endpoints
Needs to be an object containing your routes. Supports multiple verbs, data, headers, and everything. Look at [here](https://github.com/matteofigus/api-benchmark#route-object) for the full documentation
#### config.options
Supports a lot of options. Look at [here](https://github.com/matteofigus/api-benchmark#options-object) for the complete list.
# Contributing
For the latest updates and release information follow [@matteofigus](https://twitter.com/matteofigus) on twitter.
Feel free to open new Issues in case of Bugs or Feature requests.
Pull requests are welcome, possibly in new branches.
### Tests
```shell
grunt test
```
### TODO
* History analysis report ([ask for details](https://twitter.com/matteofigus))
# License
MIT