https://github.com/h2non/apitance
[WIP] Gherkin-driven HTTP API testing made easy
https://github.com/h2non/apitance
Last synced: 4 days ago
JSON representation
[WIP] Gherkin-driven HTTP API testing made easy
- Host: GitHub
- URL: https://github.com/h2non/apitance
- Owner: h2non
- License: mit
- Created: 2014-10-01T09:51:26.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-09-20T21:04:41.000Z (over 10 years ago)
- Last Synced: 2024-10-18T11:25:11.534Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 734 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 52
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# apitance [][travis] [](https://codeclimate.com/github/h2non/apitance) [][npm]
**Acceptance testing framework** for **HTTP** testing with BDD flavors, built-on-top of [Cucumber](http://cukes.info).
Not for BDD purists.
**Work in progress**
## Features
- Generic and reusable steps with expressiveness and multiple alias
- Full HTTP protocol features support, including authentication, headers, cookies
- High number of assert/expectation expressions for responses validation
- Request/responses caching, reuse and chaining
- Validate body responses against [JSON schema](http://json-schema.org/)
- Supports HAR 1.2
- API discovering based on RAML
- Support all the Cucumber.js features, such as hooks, configuration, stages...
- Built-in support for templating and variables such as environment variables
- Extended syntax with conditionals, control flow and more...
- Send body payload data from external files or remote servers
- Extending support. You can create or overwrite custom steps
## Installation
Apitance requires you have installed [node.js](http://nodejs.org) or [io.js](https://iojs.org)
```bash
[sudo] npm install -g apitance
```
Or install it as standalone self-contained package:
```bash
curl -s -L https://raw.github.com/h2non/apitance/master/scripts/installer.sh | sudo bash -v 0.1.0-beta.1
```
## Usage
```bash
$ apitance -r features/user.feature
```
## Command-line interface
Getting help
```bash
$ apitance --help
```
```bash
$ apitance -r path/to/steps path/to/feature
```
### Development
Only [node.js](http://nodejs.org)/[io.js](http://iojs.org) is required for development
Clone/fork this repository
```
$ git clone https://github.com/h2non/apitance && cd apitance
```
Install dependencies
```
$ npm install
```
Compile code
```
$ make compile
```
Run tests
```
$ make test
```
## License
[MIT](http://opensource.org/licenses/MIT) © Tomas Aparicio
[travis]: http://travis-ci.org/h2non/apitance
[gemnasium]: https://gemnasium.com/h2non/apitance
[npm]: http://npmjs.org/package/apitance
[glob]: https://github.com/isaacs/node-glob