require 'spec_helper' describe 'a simple mounted api' do before :all do class CustomType; end class SimpleMountedApi < Grape::API desc 'Document root' get do end desc 'This gets something.', notes: '_test_' get '/simple' do { bla: 'something' } end desc 'This gets something for URL using - separator.', notes: '_test_' get '/simple-test' do { bla: 'something' } end desc 'this gets something else', headers: { 'XAuthToken' => { description: 'A required header.', required: true }, 'XOtherHeader' => { description: 'An optional header.', required: false } }, http_codes: { 403 => 'invalid pony', 405 => 'no ponies left!' } get '/simple_with_headers' do { bla: 'something_else' } end desc 'this takes an array of parameters', params: { 'items[]' => { description: 'array of items' } } post '/items' do {} end desc 'this uses a custom parameter', params: { 'custom' => { type: CustomType, description: 'array of items' } } get '/custom' do {} end end class SimpleApi < Grape::API mount SimpleMountedApi add_swagger_documentation end end def app SimpleApi end it 'retrieves swagger-documentation on /swagger_doc' do get '/swagger_doc.json' expect(JSON.parse(last_response.body)).to eq( 'apiVersion' => '0.1', 'swaggerVersion' => '1.2', 'info' => {}, 'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq, 'apis' => [ { 'path' => '/simple.{format}', 'description' => 'Operations about simples' }, { 'path' => '/simple-test.{format}', 'description' => 'Operations about simple-tests' }, { 'path' => '/simple_with_headers.{format}', 'description' => 'Operations about simple_with_headers' }, { 'path' => '/items.{format}', 'description' => 'Operations about items' }, { 'path' => '/custom.{format}', 'description' => 'Operations about customs' }, { 'path' => '/swagger_doc.{format}', 'description' => 'Operations about swagger_docs' } ] ) end it 'retrieves the documentation for mounted-api' do get '/swagger_doc/simple.json' expect(JSON.parse(last_response.body)).to eq( 'apiVersion' => '0.1', 'swaggerVersion' => '1.2', 'basePath' => 'http://example.org', 'resourcePath' => '/simple', 'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq, 'apis' => [{ 'path' => '/simple.{format}', 'operations' => [{ 'notes' => '_test_', 'summary' => 'This gets something.', 'nickname' => 'GET-simple---format-', 'method' => 'GET', 'parameters' => [], 'type' => 'void' }] }] ) end context 'retrieves the documentation for mounted-api that' do it "contains '-' in URL" do get '/swagger_doc/simple-test.json' expect(JSON.parse(last_response.body)).to eq( 'apiVersion' => '0.1', 'swaggerVersion' => '1.2', 'basePath' => 'http://example.org', 'resourcePath' => '/simple-test', 'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq, 'apis' => [{ 'path' => '/simple-test.{format}', 'operations' => [{ 'notes' => '_test_', 'summary' => 'This gets something for URL using - separator.', 'nickname' => 'GET-simple-test---format-', 'method' => 'GET', 'parameters' => [], 'type' => 'void' }] }] ) end it 'includes headers' do get '/swagger_doc/simple_with_headers.json' expect(JSON.parse(last_response.body)['apis']).to eq [{ 'path' => '/simple_with_headers.{format}', 'operations' => [{ 'notes' => '', 'summary' => 'this gets something else', 'nickname' => 'GET-simple_with_headers---format-', 'method' => 'GET', 'parameters' => [ { 'paramType' => 'header', 'name' => 'XAuthToken', 'description' => 'A required header.', 'type' => 'String', 'required' => true }, { 'paramType' => 'header', 'name' => 'XOtherHeader', 'description' => 'An optional header.', 'type' => 'String', 'required' => false } ], 'type' => 'void', 'responseMessages' => [ { 'code' => 403, 'message' => 'invalid pony' }, { 'code' => 405, 'message' => 'no ponies left!' } ] }] }] end it 'supports multiple parameters' do get '/swagger_doc/items.json' expect(JSON.parse(last_response.body)['apis']).to eq [{ 'path' => '/items.{format}', 'operations' => [{ 'notes' => '', 'summary' => 'this takes an array of parameters', 'nickname' => 'POST-items---format-', 'method' => 'POST', 'parameters' => [{ 'paramType' => 'form', 'name' => 'items[]', 'description' => 'array of items', 'type' => 'string', 'required' => false, 'allowMultiple' => false }], 'type' => 'void' }] }] end it 'supports custom types' do get '/swagger_doc/custom.json' expect(JSON.parse(last_response.body)['apis']).to eq [{ 'path' => '/custom.{format}', 'operations' => [{ 'notes' => '', 'summary' => 'this uses a custom parameter', 'nickname' => 'GET-custom---format-', 'method' => 'GET', 'parameters' => [{ 'paramType' => 'query', 'name' => 'custom', 'description' => 'array of items', 'type' => 'CustomType', 'required' => false, 'allowMultiple' => false }], 'type' => 'void' }] }] end end end