apiaryio / Dredd Example
Licence: mit
Example application using Dredd and CI
Stars: ✭ 79
Programming Languages
javascript
184084 projects - #8 most used programming language
Projects that are alternatives of or similar to Dredd Example
Dredd
Language-agnostic HTTP API Testing Tool
Stars: ✭ 3,770 (+4672.15%)
Mutual labels: swagger, openapi, api-blueprint
Spot
Spot is a concise, developer-friendly way to describe your API contract.
Stars: ✭ 230 (+191.14%)
Mutual labels: swagger, openapi, api-blueprint
Apifuzzer
Fuzz test your application using your OpenAPI or Swagger API definition without coding
Stars: ✭ 101 (+27.85%)
Mutual labels: swagger, openapi, api-blueprint
Generator Express No Stress
🚂 A Yeoman generator for Express.js based 12-factor apps and apis
Stars: ✭ 534 (+575.95%)
Mutual labels: swagger, openapi, scaffold
Molten Boilerplate
A boilerplate for the molten framework by Bogdanp https://github.com/Bogdanp/molten
Stars: ✭ 50 (-36.71%)
Mutual labels: swagger, openapi
Paw Swaggerimporter
Swagger/OpenAPI 2.0 Importer for Paw
Stars: ✭ 34 (-56.96%)
Mutual labels: swagger, openapi
Swagger Jsdoc
Generates swagger/openapi specification based on jsDoc comments and YAML files.
Stars: ✭ 1,057 (+1237.97%)
Mutual labels: swagger, openapi
Connect Api Specification
This repository contains the OpenAPI specification as well as templates for generating SDKs for Square's APIs
Stars: ✭ 56 (-29.11%)
Mutual labels: swagger, openapi
Oval
oval: CLI for (O)penAPI Specification document (val)idation.
Stars: ✭ 15 (-81.01%)
Mutual labels: swagger, openapi
Intellij Swagger
A plugin to help you easily edit Swagger and OpenAPI specification files inside IntelliJ IDEA
Stars: ✭ 1,073 (+1258.23%)
Mutual labels: swagger, openapi
Azure Rest Api Specs
The source for REST API specifications for Microsoft Azure.
Stars: ✭ 1,104 (+1297.47%)
Mutual labels: swagger, openapi
Rolodex
📇API Documentation Generator for Phoenix
Stars: ✭ 34 (-56.96%)
Mutual labels: swagger, openapi
Fastapi
FastAPI framework, high performance, easy to learn, fast to code, ready for production
Stars: ✭ 39,588 (+50011.39%)
Mutual labels: swagger, openapi
Compojure Api
Sweet web apis with Compojure & Swagger
Stars: ✭ 1,056 (+1236.71%)
Mutual labels: swagger, openapi
Swagger2
Loading, parsing and validating requests to HTTP services based on Swagger v2.0 documents
Stars: ✭ 20 (-74.68%)
Mutual labels: swagger, openapi
Oav
Tools for validating OpenAPI (Swagger) files.
Stars: ✭ 55 (-30.38%)
Mutual labels: swagger, openapi
Sanic Nginx Docker Example
Sanic + Nginx + Docker basic example
Stars: ✭ 77 (-2.53%)
Mutual labels: example, skeleton
Springdoc Openapi
Library for OpenAPI 3 with spring-boot
Stars: ✭ 1,113 (+1308.86%)
Mutual labels: swagger, openapi
Express Jsdoc Swagger
Swagger OpenAPI 3.x generator
Stars: ✭ 69 (-12.66%)
Mutual labels: swagger, openapi
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:
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
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].