{"id":28376676,"url":"https://github.com/apiaryio/dredd-example","last_synced_at":"2026-03-03T12:32:41.432Z","repository":{"id":10448667,"uuid":"12617394","full_name":"apiaryio/dredd-example","owner":"apiaryio","description":"Example application using Dredd and CI","archived":true,"fork":false,"pushed_at":"2021-07-26T13:48:07.000Z","size":120,"stargazers_count":85,"open_issues_count":4,"forks_count":61,"subscribers_count":20,"default_branch":"master","last_synced_at":"2025-05-30T00:07:33.833Z","etag":null,"topics":["api-blueprint","dredd","example","openapi","openapi-validation","openapi2","scaffold","sjs-team","skeleton","swagger"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apiaryio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-09-05T12:42:36.000Z","updated_at":"2024-11-08T09:04:01.000Z","dependencies_parsed_at":"2022-08-30T12:30:45.993Z","dependency_job_id":null,"html_url":"https://github.com/apiaryio/dredd-example","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/apiaryio/dredd-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiaryio%2Fdredd-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiaryio%2Fdredd-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiaryio%2Fdredd-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiaryio%2Fdredd-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apiaryio","download_url":"https://codeload.github.com/apiaryio/dredd-example/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiaryio%2Fdredd-example/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262047824,"owners_count":23250422,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-blueprint","dredd","example","openapi","openapi-validation","openapi2","scaffold","sjs-team","skeleton","swagger"],"created_at":"2025-05-30T00:07:32.340Z","updated_at":"2026-03-03T12:32:36.385Z","avatar_url":"https://github.com/apiaryio.png","language":"JavaScript","readme":"# Dredd Example\n\nThis is an example application to demonstrate how easily you can employ the [Dredd](https://github.com/apiaryio/dredd) testing tool as part of your [API design life cycle](https://apiary.io/how-to-build-api).\n\n## How It Works\n\nThere 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](https://en.wikipedia.org/wiki/Continuous_integration) 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.\n\n## API Description Examples\n\n### [API Blueprint][]\n\n- Document: [apiblueprint/api.apib][]\n- Dredd configuration: [apiblueprint/dredd.yml][]\n- Dredd hooks: [apiblueprint/hooks.js][]\n\n### [OpenAPI 2][] (formerly known as Swagger)\n\n- Document: [openapi2/api.yml][]\n- Dredd configuration: [openapi2/dredd.yml][]\n- Dredd hooks: [openapi2/hooks.js][]\n\n## CI Examples\n\n| CI            | Configuration            | Status                                      |\n| ------------- | ------------------------ | ------------------------------------------- |\n| [Wercker][]   | [wercker.yml][]          | [![Wercker Build Status][]][wercker-link]   |\n| [Travis CI][] | [.travis.yml][]          | [![Travis CI Build Status][]][travis-link]  |\n| [CircleCI][]  | [.circleci/config.yml][] | [![CircleCI Build Status][]][circle-link]   |\n| [AppVeyor][]  | [appveyor.yml][]         | [![AppVeyor Build Status][]][appveyor-link] |\n| [Jenkins][]   | [Jenkinsfile][]          | N/A                                         |\n\n## Tutorials\n\nTo learn more about about Dredd, read:\n\n- [Dredd Documentation](http://dredd.readthedocs.io/)\n- [Dredd's GitHub Repository](https://github.com/apiaryio/dredd)\n\nTo learn how to use Dredd with your CI, read:\n\n- [Continuous Integration](http://dredd.readthedocs.io/en/latest/how-to-guides/#continuous-integration) how-to guide in Dredd's documentation\n- [Continuous API Testing](https://help.apiary.io/tools/automated-testing/testing-ci/) page in Apiary Help\n\n\n[API Blueprint]: http://apiblueprint.org/\n[apiblueprint/api.apib]: apiblueprint/api.apib\n[apiblueprint/dredd.yml]: apiblueprint/dredd.yml\n[apiblueprint/hooks.js]: apiblueprint/hooks.js\n\n[OpenAPI 2]: https://www.openapis.org/\n[openapi2/api.yml]: openapi2/api.yml\n[openapi2/dredd.yml]: openapi2/dredd.yml\n[openapi2/hooks.js]: openapi2/hooks.js\n\n\n[Wercker]: https://www.wercker.com/\n[Wercker Build Status]: https://app.wercker.com/status/8e5dbc0f8c677262bbcdbb226b7be168/s/master\n[wercker-link]: https://app.wercker.com/project/byKey/8e5dbc0f8c677262bbcdbb226b7be168\n[wercker.yml]: wercker.yml\n\n[Travis CI]: https://www.travis-ci.org/\n[Travis CI Build Status]: https://travis-ci.org/apiaryio/dredd-example.svg?branch=master\n[travis-link]: https://travis-ci.org/apiaryio/dredd-example\n[.travis.yml]: .travis.yml\n\n[CircleCI]: https://circleci.com/\n[CircleCI Build Status]: https://circleci.com/gh/apiaryio/dredd-example.svg?style=svg\n[circle-link]: https://circleci.com/gh/apiaryio/dredd-example\n[.circleci/config.yml]: .circleci/config.yml\n\n[AppVeyor]: https://www.appveyor.com/\n[AppVeyor Build Status]: https://ci.appveyor.com/api/projects/status/7cqqqpnrlhd2dkg1/branch/master?svg=true\n[appveyor-link]: https://ci.appveyor.com/project/Apiary/dredd-example/branch/master\n[appveyor.yml]: appveyor.yml\n\n[Jenkins]: https://jenkins.io/\n[Jenkinsfile]: Jenkinsfile\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapiaryio%2Fdredd-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapiaryio%2Fdredd-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapiaryio%2Fdredd-example/lists"}