Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apiaryio/gavel-spec
Behavior specification for Gavel, validator of HTTP transactions
https://github.com/apiaryio/gavel-spec
bdd cucumber dredd gavel gherkin http http-transactions sjs-team test-suite validation
Last synced: 3 months ago
JSON representation
Behavior specification for Gavel, validator of HTTP transactions
- Host: GitHub
- URL: https://github.com/apiaryio/gavel-spec
- Owner: apiaryio
- License: mit
- Created: 2013-07-03T14:28:28.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2022-05-19T03:25:37.000Z (over 2 years ago)
- Last Synced: 2024-05-17T05:20:55.763Z (8 months ago)
- Topics: bdd, cucumber, dredd, gavel, gherkin, http, http-transactions, sjs-team, test-suite, validation
- Language: Gherkin
- Homepage: http://www.relishapp.com/apiary/gavel/
- Size: 501 KB
- Stars: 105
- Watchers: 18
- Forks: 11
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Behavior spec for Gavel, validator of HTTP transactions
[][Gavel on Relish]
[](https://badge.fury.io/js/gavel-spec)
[](https://greenkeeper.io/)
## What is Gavel?
Gavel detects important differences between actual and expected HTTP transactions (HTTP request and response pairs). Gavel also decides whether the actual HTTP transaction is valid or not.
### Implementations
- [JavaScript][Gavel.js] [](https://travis-ci.org/apiaryio/gavel.js) [][Gavel.js on Relish]
- Didn't find your favorite language? _[Add a new one!](features/add-implementation.md)_
### Documentation
- [Gavel on Relish][]
## About `gavel-spec`
This repository contains implementation-independent behavior specification of Gavel. It's written in [Gherkin][], language used by [Cucumber][]. Two main benefits are:
- Any Gavel implementation can be tested against the specification, which ensures the behavior is uniform.
- Documentation at [Relish][] is generated from the specification, which ensures it's always up-to-date.
Examples are made in raw HTTP to focus on implementation independence.
### Usage
To use the specification in your project and test against it, install it as [npm package][] (or include as a [git submodule][]):
```sh
$ npm install gavel-spec
...
$ find ./node_modules/gavel-spec/features/**/*.feature
./node_modules/gavel-spec/features/expectations/body_json_example.feature
./node_modules/gavel-spec/features/expectations/body_text_example.feature
./node_modules/gavel-spec/features/expectations/headers.feature
./node_modules/gavel-spec/features/expectations/status_code.feature
...
```
It's also possible to get path to the directory with features from JavaScript:
```javascript
var featuresPath = require('gavel-spec').featuresPath;
console.log(featuresPath); // prints '/.../node_modules/gavel-spec/features/'
```
Use [Cucumber][] for testing.
### Publishing Documentation
Currently publishing of a new version of the generated documentation is done manually:
1. Install Relish CLI: `gem install relish`
2. Add current version: `relish versions:add apiary/gavel:1.1.0` (the `1.1.0` should be the same number which appears on npm as the latest package version)
3. Publish new version of the documentation: `relish push apiary/gavel:1.1.0 path ./features/`
Steps 2-3 has been simplified as `npm run docs:publish` command.
[Relish]: https://www.relishapp.com/
[Gavel on Relish]: https://www.relishapp.com/apiary/gavel
[Gavel.js]: https://github.com/apiaryio/gavel.js
[Gavel.js on Relish]: https://www.relishapp.com/apiary/gavel/docs/javascript/
[Gherkin]: https://github.com/cucumber/gherkin
[Cucumber]: https://github.com/cucumber/cucumber
[git submodule]: https://git-scm.com/book/en/v2/Git-Tools-Submodules
[npm package]: https://www.npmjs.com/package/gavel-spec