Contents

class SampleApi < Grape::API
  resource 'widgets' do
    desc 'widgets list'
    get '/' do
    end

    desc 'individual widget'
    get ':id' do
    end

    desc 'create a widget'
    params do
      requires 'name',
        type: String,
        desc: 'the widgets name',
        documentation: { example: 'super widget' }
      optional :description,
        type: String,
        desc: 'the widgets name',
        documentation: { example: 'the best widget ever made' }
    end
    post '/' do
    end

    desc 'update a widget'
    params do
      optional :name, type: String, desc: 'the widgets name'
      optional :description, type: String, desc: 'the widgets name'
    end
    put ':id' do
    end
  end

  resource 'admin' do
    get '/' do
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
grape-apiary-1.0.0	spec/support/sample_api.rb
grape-apiary-0.2.0	spec/support/sample_api.rb
grape-apiary-0.1.2	spec/support/sample_api.rb
grape-apiary-0.1.1	spec/support/sample_api.rb