galipalli/dredd-example

Example application using Dredd and CI

Dredd Example

This is an example application to demonstrate how easily you can employ the Dredd testing tool as part of your API design life cycle.

How It Works

There is a sample Gist Fox API implementation in the app.js file. Every time code of the application is modified and the changes are sent to GitHub, they are tested by Dredd in CI against both API Blueprint and OpenAPI 2 (fka Swagger) API description formats. If the implementation doesn't follow description of the API, the CI build fails.

API Description Examples

API Blueprint

• Document: apiblueprint/api.apib
• Dredd configuration: apiblueprint/dredd.yml
• Dredd hooks: apiblueprint/hooks.js

OpenAPI 2 (formerly known as Swagger)

• Document: openapi2/api.yml
• Dredd configuration: openapi2/dredd.yml
• Dredd hooks: openapi2/hooks.js

CI Examples

CI	Configuration	Status
Wercker	wercker.yml
Travis CI	.travis.yml
CircleCI	.circleci/config.yml
AppVeyor	appveyor.yml
Jenkins	Jenkinsfile	N/A

Tutorials

To learn more about about Dredd, read:

• Dredd Documentation
• Dredd's GitHub Repository

To learn how to use Dredd with your CI, read:

• Continuous Integration how-to guide in Dredd's documentation
• Continuous API Testing page in Apiary Help