Apipony

Ruby DSL to create Rails API documentation from your application.

Getting started

• Add gem 'apipony' to Gemfile
• bundle install
• rails g apipony:install
• Now you can edit your documentation in config/initializers/apipony.rb

How it works

DSL example:

Apipony::Documentation.define do
  config do |c|
    c.title = 'Apipony Documentation'
    c.base_url = '/api/v1'
  end

  section 'Ponies' do
    endpoint 'get', '/ponies' do |e|
      e.description = 'Find ponies'

      request_with do
        set :params, {
          :name => :applejack
        }
      end

      response_with 200 do
        set :body, {
          :name => :applejack,
          :kind => :earth,
          :sex => :female,
          :occupation => :farmer
        }
      end
    end
  end
end

Generated documentation example:

By default documentation available here /apipony. But you can always change it in config/routes.rb.