Contents

require 'spec_helper'

describe 'API Description' do
  context 'with no additional options' do
    subject do
      Class.new(Grape::API) do
        add_swagger_documentation
      end
    end

    it 'describes the API with defaults' do
      routes = subject.endpoints.first.routes
      expect(routes.count).to eq 2
      expect(routes.first.description).to eq 'Swagger compatible API description'
      expect(routes.first.params).to eq('locale' => { desc: 'Locale of API documentation', type: 'Symbol', required: false })
      expect(routes.last.description).to eq 'Swagger compatible API description for specific API'
      expect(routes.last.params).to eq('name' => { desc: 'Resource name of mounted API', type: 'String', required: true },
                                       'locale' => { desc: 'Locale of API documentation', type: 'Symbol', required: false })
    end
  end

  context 'with additional options' do
    subject do
      Class.new(Grape::API) do
        add_swagger_documentation \
          api_documentation: { desc: 'First', params: { x: 1 }, xx: 11 },
          specific_api_documentation: { desc: 'Second', params: { y: 42 }, yy: 4242 }
      end
    end

    it 'describes the API with defaults' do
      routes = subject.endpoints.first.routes
      expect(routes.count).to eq 2
      expect(routes.first.description).to eq 'First'
      expect(routes.first.params).to eq(x: 1, 'locale' => { desc: 'Locale of API documentation', type: 'Symbol', required: false })
      expect(routes.first.settings[:description][:xx]).to eq(11)
      expect(routes.last.description).to eq 'Second'
      expect(routes.last.params).to eq('name' => { desc: 'Resource name of mounted API', type: 'String', required: true }, y: 42,
                                       'locale' => { desc: 'Locale of API documentation', type: 'Symbol', required: false })
      expect(routes.last.options[:yy]).to eq(4242)
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
grape-swagger-0.11.0	spec/api_description_spec.rb