"The confident hippie"
hippie-swagger
is a tool for testing RESTful APIs that includes built-in swagger assertions.
Write your usual API tests, and any request or response details not matching the swagger file will throw an exception, failing the spec. This ensures the swagger definition accurately describes application behavior, and doesn't become out of sync.
hippie-swagger
uses hippie under the hood, an excellent API testing tool.
- All hippie features included
- All aspects of swagger file validated; parameters, request/response body, paths, etc.
- Checks for extra parameters, paths, headers, etc not mentined in the swagger file
- Ensures swagger file accurately describes API behavior
- Accurate, human readable assertion messages
npm install hippie-swagger --save-dev
var hippie = require('hippie-swagger'),
swagger = require('dereferenced-swagger-file');
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;
});
- See hippie documentation for a description of the base api
- When specifying a url(.get, .post, .patch, .url, etc), use the swagger path
- Provide any path variables using pathParams
These aside, use hippie as you normally would; see the example.
Replaces variables contained in the swagger path.
hippie(app, swagger)
.get('/projects/{projectId}/tasks/{taskId}')
.pathParams({
projectId: 123,
taskId: 99
})
.end(fn);
To customize behavior, an options
hash may be passed as a third argument:
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
)
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
)
See the example folder
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:
hippie(app, swagger)
.get('/pathNotMentionedInSwagger')
.end(fn);
// path does not exist in swagger file; throws:
// Swagger spec does not define path: pathNotMentionedInSwagger
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}
hippie(app, swagger)
.get('/users/{username}')
.end(fn);
// "username" is marked 'required' in swagger file; throws:
// Missing required parameter in path: username
hippie(app, swagger)
.get('/users')
.pathParams({
extraParam: 'will-throw',
})
.end(fn);
// "extraParam" not mentioned swagger file; throws:
// Parameter not mentioned in swagger spec: "extraParam"
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]
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
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"}
hippie(app, swagger)
.form()
.post('/users')
.send({})
.end(fn);
// "username" is {required: true, in: formData} in swagger; throws:
// Missing required parameter in formData: username
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
The most common mistake is forgetting to dereference the swagger file:
"'Error: cant resolve reference ...'
Dereferencing can be accomplished using swagger-parser. The example gives a demonstration.