Contents

require 'spec_helper'

describe 'hide documentation path' do
  include_context 'the api entities'

  before :all do
    module TheApi
      class HideDocumentationApi < Grape::API
        format :json

        desc 'This returns something',
             params: Entities::UseResponse.documentation,
             failure: [{ code: 400, message: 'NotFound', model: Entities::ApiError }]
        params do
          requires :foo, type: Integer
        end
        get '/params_response' do
          { 'declared_params' => declared(params) }
        end

        desc 'This returns something',
             entity: Entities::UseResponse,
             failure: [{ code: 400, message: 'NotFound', model: Entities::ApiError }]
        get '/entity_response' do
          { 'declared_params' => declared(params) }
        end

        desc 'This returns something',
             failure: [{ code: 400, message: 'NotFound', model: Entities::ApiError }]
        get '/present_response' do
          foo = OpenStruct.new id: 1, name: 'bar'
          something = OpenStruct.new description: 'something', item: foo
          present :somethings, something, with: Entities::UseResponse
        end

        add_swagger_documentation hide_documentation_path: false
      end
    end
  end

  def app
    TheApi::HideDocumentationApi
  end

  describe 'shows documentation paths' do
    subject do
      get '/swagger_doc'
      JSON.parse(last_response.body)
    end

    specify do
      expect(subject['paths'].keys).to include '/swagger_doc', '/swagger_doc/{name}'
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
grape-swagger-0.20.3	spec/swagger_v2/api_swagger_v2_hide_documentation_path_spec.rb