Backdrop Gem Version Build Status Coverage Status Code Climate

Detects all APIs required and generates stubs based on RAD documentation

Installation

Gemfile

gem 'backdrop'

config/routes.rb

mount Backdrop::App => '/backdrop'

Ensure your APIs are generating JSON docs

RspecApiDocumentation.configure do |config|
  config.format = :json
end

Configuration

config/initializers/backdrop_init.rb

Backdrop.configure do |config|
  config.output_dir = 'output_directory'
end

Generating Stubs

Create a rake task with an array of paths to your API projects

lib/tasks/backdrop.rake

require 'backdrop/rake_task'

Backdrop::RakeTask.new('output_directory', ['/paths/to/projects'])

Call rake backdrop to create all RAD APIs in the specified output directory

Dependencies

  • Ruby >= 2.0.0