Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cachecontrol/hippie-swagger
API testing tool with automatic swagger assertions
https://github.com/cachecontrol/hippie-swagger
api-testing documentation documentation-tool hippie swagger swagger-spec
Last synced: 7 days ago
JSON representation
API testing tool with automatic swagger assertions
- Host: GitHub
- URL: https://github.com/cachecontrol/hippie-swagger
- Owner: CacheControl
- License: isc
- Created: 2015-08-10T15:16:24.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T16:16:09.000Z (about 2 years ago)
- Last Synced: 2024-12-15T12:06:52.387Z (7 days ago)
- Topics: api-testing, documentation, documentation-tool, hippie, swagger, swagger-spec
- Language: JavaScript
- Homepage:
- Size: 530 KB
- Stars: 180
- Watchers: 11
- Forks: 24
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
_"The confident hippie"_
[](http://standardjs.com/)
[](https://github.com/cachecontrol/hippie-swagger/workflows/Node.js%20CI/badge.svg?branch=master)
[](https://badge.fury.io/js/hippie-swagger)
## Synopsis
```hippie-swagger``` is a tool for testing RESTful APIs. In addition to validating api behavior, it will fail tests when swagger documentation is missing or inaccurate.
As the test suite runs, any request or response details *not* matching the swagger file will throw an appropriate exception, failing the spec. This ensures the swagger definition accurately describes application behavior, keeping documentation in sync with reality.
```hippie-swagger``` uses [hippie](https://github.com/vesln/hippie) under the hood, an excellent API testing tool.
## Features
* All [hippie](https://github.com/vesln/hippie) features included
* All aspects of swagger file validated; parameters, request/response body, paths, etc.
* Checks for extra parameters, paths, headers, etc not mentioned in the swagger file
* Ensures swagger file accurately describes API behavior
* Accurate, human readable assertion messages
## Installation
```
npm install hippie-swagger --save-dev
```
## Basic Usage
```js
var hippie = require('hippie-swagger'),
swagger = require('./my-dereferenced-swagger-file'); // see example for how to dereference swagger
hippie(app, swagger)
.get('/users/{username}')
.pathParams({
username: 'cachecontrol'
})
.expectStatus(200)
.expectValue('user.first', 'John')
.expectHeader('cache-control', 'no-cache')
.end(function(err, res, body) {
if (err) throw err;
});
```
## Usage
* See [hippie](https://github.com/vesln/hippie) documentation for a description of the base api
* When specifying a url(.get, .post, .patch, .url, etc), use the [swagger path](http://swagger.io/specification/#pathsObject)
* Provide any path variables using [pathParams](#pathparams)
These aside, use hippie as you normally would; see the [example](example/index.js).
## Methods
### #constructor (Object app, Object swagger, Object [options])
Test an HTTP app (like express) directly
```js
hippie(app, swagger, options)
.get('/projects')
.end(fn);
```
### #constructor (Object swagger, Object [options])
Test a remote HTTP app using a fully qualified url
```js
hippie(swagger, options)
.get('http://localhost:3000/projects')
.end(fn);
```
### #pathParams(Object hash)
Replaces variables contained in the swagger path.
```js
hippie(app, swagger)
.get('/projects/{projectId}/tasks/{taskId}')
.pathParams({
projectId: 123,
taskId: 99
})
.end(fn);
```
## Options
To customize behavior, an ```options``` hash may be passed to the constructor. Typically, ```options``` only need to be specified in situations where the test covers responses to improper requests (e.g. validating the application returns a 422 when a required parameter is not provided).
```js
var options = {
validateResponseSchema: true,
validateParameterSchema: true,
errorOnExtraParameters: true,
errorOnExtraHeaderParameters: false
};
hippie(app, swagger, options)
```
```validateResponseSchema``` - Validate the server's response against the swagger json-schema definition (default: ```true```)
```validateParameterSchema``` - Validate the request parameters against the swagger json-schema definition (default: ```true```)
```validateRequiredParameters``` - Validate that required parameters were provided (default: ```true```)
```errorOnExtraParameters``` - Throw an error if a parameter is missing from the swagger file (default: ```true```)
```errorOnExtraHeaderParameters``` - Throw an error if a request header is missing from the swagger file. By default this is turned off, because it results in every request needing to specify the "Content-Type" and "Accept" headers, which quickly becomes verbose. (default: ```false```)
## Example
See the [example](example/index.js) folder
## Validations
When hippie-swagger detects it is interacting with the app in ways not specified in the swagger file, it will throw an error and fail the test. The idea is to use hippie's core features to write API tests as per usual, and hippie-swagger will only interject if the swagger contract is violated.
Below are list of some of the validations that hippie-swagger checks for:
### Paths
```js
hippie(app, swagger)
.get('/pathNotMentionedInSwagger')
.end(fn);
// path does not exist in swagger file; throws:
// Swagger spec does not define path: pathNotMentionedInSwagger
```
### Parameter format
```js
hippie(app, swagger)
.get('/users/{userId}')
.pathParams({
userId: 'string-value',
})
.end(fn);
// userId provided as a string, but swagger specifies it as an integer; throws:
// Invalid format for parameter {userId}
```
### Required Parameters
```js
hippie(app, swagger)
.get('/users/{username}')
.end(fn);
// "username" is marked 'required' in swagger file; throws:
// Missing required parameter in path: username
```
### Extraneous Parameters
```js
hippie(app, swagger)
.get('/users')
.qs({ page: 2, limit: 30 })
.end(fn);
// "page" missing from swagger file; throws:
// Error: query parameter not mentioned in swagger spec: "page", available params: limit
```
### Response format
```js
hippie(app, swagger)
.get('/users')
.end(fn);
// body failed to validate against swagger file's "response" schema; throws:
// Response from /users failed validation: [failure description]
```
### Method validation
```js
hippie(app, swagger)
.post('/users')
.end(fn);
// "post" method not mentioned in swagger file; throws:
// Swagger spec does not define method: "post" in path /users
```
### Post body format
```js
hippie(app, swagger)
.post('/users')
.send({"bogus":"post-body"})
.end(fn);
// post body fails to validate against swagger file's "body" parameter; throws:
// Invalid format for parameter {body}, received: {"bogus":"post-body"}
```
### Form Url-Encoded Parameters
```js
hippie(app, swagger)
.form()
.post('/users')
.send({})
.end(fn);
// "username" is {required: true, in: formData} in swagger; throws:
// Missing required parameter in formData: username
```
### Multipart Forms
```js
hippie(app, swagger)
.header('Content-Type','multipart/form-data')
.send()
.post('/users/upload')
.end(fn);
// "fileUpload" is {required: true, in: formData, type: file} in swagger; throws:
// Missing required parameter in formData: fileUpload
```
## Troubleshooting
The most common mistake is forgetting to dereference the swagger file:
```js
"'Error: cant resolve reference ...'
```
Dereferencing can be accomplished using [swagger-parser](https://github.com/BigstickCarpet/swagger-parser/blob/master/docs/swagger-parser.md#dereferenceapi-options-callback). The [example](example/index.js) gives a demonstration.
## Contributing
To run the `hippie-swagger` tests:
```
npm test
```
## License
[ISC](./LICENSE)