Dredd::Rack

This gem provides a Dredd runner and a blueprint:verify rake task to make API blueprint testing convenient for Rack applications. When verifying blueprints locally, an application server is automatically set up, without need of any manual intervention.

Besides being convenient, that allows to use the API blueprints as acceptance test suites to practice BDD with Dredd and RSpec, for example, while clients developers use Apiary as a mock server.

Installation

Add the gem to your Gemfile:

# Gemfile

gem 'dredd-rack', '~> 1.0' # see semver.org

Getting Started

Dredd::Rack::Runner

To do.

Rake task

Use the dredd rake task from your Rakefile:

# Rakefile

require 'dredd/rack'

# Configure Dredd::Rack to automatically set a server up for your application
Dredd::Rack.app Sinatra::Application # or the name of your modular-style app, or Rails app

# That's all!

# Optionally add the API blueprint verification to the default test suite
# task :default => [:spec, :dredd]

Run the API blueprint verification locally:

rake dredd

# or specify a remote server:
#API_HOST=http://api.example.com rake blueprint:verify

Usage

Custom rake task name or description

You can also define a custom rake task name or description:

# Rakefile

require 'dredd/rack'

# Configure Dredd::Rack to automatically set a server up for your application
Dredd::Rack.app Sinatra::Application # or the name of your modular-style app, or Rails app

namespace :blueprint do
  desc 'Verify an API complies with its blueprint'
  Dredd::Rack::RakeTask.new(:verify)
end

License

Dredd::Rack provides convenient API blueprint testing to Rack applications.
Copyright (C) 2015  Gonzalo Bulnes Guilpain

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.