grape-swagger 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a1bf3c5bf4c84bdda47522ddc8148c78c538995
-  data.tar.gz: 04f9c3468140334518a3051593c5ff94da824a0a
+  metadata.gz: e9e2d67cf94749b685aff4146aa6f831acd41539
+  data.tar.gz: 272fa686ecf0e978a0f07c41a42486a06ecfd56c
 SHA512:
-  metadata.gz: 302ac60608a12fcbb40ea2988ad73a4459e469605058992aa379f6c6d5d043855560db1d57de531a280e05e054cab6d962cbc6847f405166fec25aadd5d2deb7
-  data.tar.gz: 9b1a01f0aac40776531b393465e24baa14b873824ada7171df0e546711bb92d143804d44339b8ae27fd1313afcd74e46aa50fe92ce059807c55d86b87dcff219
+  metadata.gz: 612b8bff2f52780da77e09b63a929cb035d3cc6f8bcda1a75b426c7267c67e60f86d30eefa149e05f6ec27571317cef910daf53026b7d3394d149ccafb96ce07
+  data.tar.gz: 22b1bd381a910aedb712fa1efc53b36ded5965ae743dae44527f49208cc23243d8d97f3ff76694d984f06e2ede024d5d2b01feda3356c436a5890a44b3e06930

data/.rubocop.yml

@@ -1,36 +1,5 @@
 AllCops:
-  Excludes:
+  Exclude:
     - vendor/**/*
 
-LineLength:
-  Enabled: false
-
-MethodLength:
-  Enabled: false
-
-ClassLength:
-  Enabled: false
-
-Documentation:
-  # don't require classes to be documented
-  Enabled: false
-
-Encoding:
-  # no need to always specify encoding
-  Enabled: false
-
-FileName:
-  # allow grape-swagger.rb
-  Enabled: false
-
-PredicateName:
-  Enabled: false
-
-DoubleNegation:
-  Enabled: false
-
-CyclomaticComplexity:
-  Enabled: false
-
-ClassVars:
-  Enabled: false
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,55 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-11-29 13:48:01 -0500 using RuboCop version 0.27.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 8
+Metrics/AbcSize:
+  Max: 327
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 397
+
+# Offense count: 5
+Metrics/CyclomaticComplexity:
+  Max: 93
+
+# Offense count: 195
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 254
+
+# Offense count: 13
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 359
+
+# Offense count: 4
+Metrics/PerceivedComplexity:
+  Max: 96
+
+# Offense count: 7
+Style/ClassVars:
+  Enabled: false
+
+# Offense count: 69
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 2
+Style/DoubleNegation:
+  Enabled: false
+
+# Offense count: 3
+# Configuration parameters: Exclude.
+Style/FileName:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: NamePrefix, NamePrefixBlacklist.
+Style/PredicateName:
+  Enabled: false

data/.travis.yml

@@ -1,8 +1,16 @@
+language: ruby
+
+sudo: false
+
 rvm:
-  - jruby-19mode
-  - 1.9.3
+  - 2.1.1
   - 2.0.0
-  - 2.1.2
+  - 1.9.3
   - rbx-2.2.10
+  - jruby-19mode
 
-
+env:
+  - GRAPE_VERSION=0.8.0
+  - GRAPE_VERSION=0.9.0
+  - GRAPE_VERSION=0.10.0
+  - GRAPE_VERSION=HEAD

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+### 0.9.0 (December 19, 2014)
+
+* [#91](https://github.com/tim-vandecasteele/grape-swagger/issues/91): Fixed empty field for group parameters' name with type hash or Array - [@dukedave](https://github.com/dukedave).
+* [#154](https://github.com/tim-vandecasteele/grape-swagger/pull/154): Allow classes for type declarations inside documentation - [@mrmargolis](https://github.com/mrmargolis).
+* [#162](https://github.com/tim-vandecasteele/grape-swagger/pull/162): Fix performance issue related to having a large number of models - [@elado](https://github.com/elado).
+* [#169](https://github.com/tim-vandecasteele/grape-swagger/pull/169): Test against multiple versions of Grape - [@dblock](https://github.com/dblock).
+* [#166](https://github.com/tim-vandecasteele/grape-swagger/pull/166): Ensure compatibility with Grape 0.8.0 or newer - [@dblock](https://github.com/dblock).
+* [#174](https://github.com/tim-vandecasteele/grape-swagger/pull/172): Fix problem with using prefix name somewhere in api paths - [@grzesiek](https://github.com/grzesiek).
+* [#176](https://github.com/tim-vandecasteele/grape-swagger/pull/176): Added ability to load nested models recursively - [@sergey-verevkin](https://github.com/sergey-verevkin).
+* [#179](https://github.com/tim-vandecasteele/grape-swagger/pull/179): Document `Virtus::Attribute::Boolean` as boolean - [@eashman](https://github.com/eashman), [@dblock](https://github.com/dblock).
+* [#178](https://github.com/tim-vandecasteele/grape-swagger/issues/178): Fixed `Hash` parameters, now exposed as Swagger `object` types - [@dblock](https://github.com/dblock).
+* [#167](https://github.com/tim-vandecasteele/grape-swagger/pull/167): Support mutli-tenanted APIs, don't cache `base_path` - [@bradrobertson](https://github.com/bradrobertson), (https://github.com/dblock).
+* [#185](https://github.com/tim-vandecasteele/grape-swagger/pull/185): Support strings in `Grape::Entity.expose`'s `:using` option - [@jhollinger](https://github.com/jhollinger).
+
 ### 0.8.0 (August 30, 2014)
 
 #### Features

data/Gemfile

@@ -1,3 +1,10 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 gemspec
+
+case version = ENV['GRAPE_VERSION'] || '~> 0.9.0'
+when 'HEAD'
+  gem 'grape', github: 'intridea/grape'
+else
+  gem 'grape', version
+end

data/README.md

@@ -6,7 +6,7 @@
 
 The grape-swagger gem provides an autogenerated documentation for your [Grape](https://github.com/intridea/grape) API. The generated documentation is Swagger-compliant, meaning it can easily be discovered in [Swagger UI](https://github.com/wordnik/swagger-ui). You should be able to point [the petstore demo](http://petstore.swagger.wordnik.com) to your API.
 
-![Demo Screenshot](test/splines.png)
+![Demo Screenshot](example/splines.png)
 
 ## Related Projects
 
@@ -25,7 +25,7 @@ Please see [UPGRADING](UPGRADING.md) when upgrading from a previous version.
 
 ## Usage
 
-Mount all your different APIs (with ```Grape::API``` superclass) on a root node. In the root class definition, include ```add_swagger_documentation```, this sets up the system and registers the documentation on '/swagger_doc.json'. See [test/api.rb](test/api.rb) for a simple demo.
+Mount all your different APIs (with ```Grape::API``` superclass) on a root node. In the root class definition, include ```add_swagger_documentation```, this sets up the system and registers the documentation on '/swagger_doc.json'. See [example/api.rb](example/api.rb) for a simple demo.
 
 
 ``` ruby
@@ -227,6 +227,8 @@ end
 
 ### Relationships
 
+Put the full name of the relationship's class in `type`, leaving out any modules named `Entities` or `Entity`. So for the entity class `API::Entities::Address`, you would put `type: 'API::Address'`.
+
 #### 1xN
 
 ```ruby
@@ -235,7 +237,7 @@ module API
     class Client < Grape::Entity
       expose :name, documentation: { type: 'string', desc: 'Name' }
       expose :addresses, using: Entities::Address,
-        documentation: { type: 'Address', desc: 'Addresses.', param_type: 'body', is_array: true }
+        documentation: { type: 'API::Address', desc: 'Addresses.', param_type: 'body', is_array: true }
     end
 
     class Address < Grape::Entity
@@ -266,7 +268,7 @@ module API
     class Client < Grape::Entity
       expose :name, documentation: { type: 'string', desc: 'Name' }
       expose :address, using: Entities::Address,
-        documentation: { type: 'Address', desc: 'Addresses.', param_type: 'body', is_array: false }
+        documentation: { type: 'API::Address', desc: 'Addresses.', param_type: 'body', is_array: false }
     end
 
     class Address < Grape::Entity
@@ -313,14 +315,14 @@ add_swagger_documentation(
 Finally you can write endpoint descriptions the with markdown enabled.
 
 ``` ruby
-desc "Reserve a virgin in heaven", {
+desc "Reserve a burger in heaven", {
   notes: <<-NOTE
-    Virgins in Heaven
+    Veggie Burgers in Heaven
     -----------------
 
-    > A virgin doesn't come for free
+    > A veggie burger doesn't come for free
 
-    If you want to reserve a virgin in heaven, you have to do
+    If you want to reserve a veggie burger in heaven, you have to do
     some crazy stuff on earth.
 
         def do_good

data/{test → example}/api.rb

@@ -34,6 +34,10 @@ class Api < Grape::API
     desc 'Create a spline.'
     params do
       optional :reticulated, type: Boolean, default: true, desc: 'True if the spline is reticulated.'
+      requires :required_group, type: Hash do
+        requires :required_param_1
+        requires :required_param_2
+      end
     end
     post do
       spline = { id: @@splines.size + 1, reticulated: params[:reticulated] }

data/grape-swagger.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.summary     = 'A simple way to add auto generated documentation to your Grape API that can be displayed with Swagger.'
   s.license     = 'MIT'
 
-  s.add_runtime_dependency 'grape'
+  s.add_runtime_dependency 'grape', '>= 0.8.0'
   s.add_runtime_dependency 'grape-entity'
 
   s.add_development_dependency 'rake'
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'rack-cors'
-  s.add_development_dependency 'rubocop', '0.24.1'
+  s.add_development_dependency 'rubocop', '0.27.0'
   s.add_development_dependency 'kramdown', '~> 1.4.1'
   s.add_development_dependency 'redcarpet', '~> 3.1.2' unless RUBY_PLATFORM.eql? 'java'
   s.add_development_dependency 'rouge', '~> 1.6.1'

data/lib/grape-swagger.rb

@@ -17,25 +17,33 @@ module Grape
 
         @combined_routes = {}
         routes.each do |route|
-          route_match = route.route_path.split(route.route_prefix).last.match('\/([\w|-]*?)[\.\/\(]')
-          next if route_match.nil?
+          route_path = route.route_path
+          route_match = route_path.split(/^.*?#{route.route_prefix.to_s}/).last
+          next unless route_match
+          route_match = route_match.match('\/([\w|-]*?)[\.\/\(]') || route_match.match('\/([\w|-]*)')
+          next unless route_match
           resource = route_match.captures.first
           next if resource.empty?
           resource.downcase!
           @combined_routes[resource] ||= []
-          next if @@hide_documentation_path && route.route_path.include?(@@mount_path)
+          next if documentation_class.hide_documentation_path && route.route_path.include?(documentation_class.mount_path)
           @combined_routes[resource] << route
         end
 
         @combined_namespaces = {}
         combine_namespaces(self)
+        documentation_class
       end
 
       private
 
       def combine_namespaces(app)
         app.endpoints.each do |endpoint|
-          ns = endpoint.settings.stack.last[:namespace]
+          ns = if endpoint.respond_to?(:namespace_stackable)
+                 endpoint.namespace_stackable(:namespace).last
+               else
+                 endpoint.settings.stack.last[:namespace]
+               end
           @combined_namespaces[ns.space] = ns if ns
 
           combine_namespaces(endpoint.options[:app]) if endpoint.options[:app]
@@ -48,179 +56,6 @@ module Grape
             def name
               @@class_name
             end
-          end
-
-          def self.setup(options)
-            defaults = {
-              target_class: nil,
-              mount_path: '/swagger_doc',
-              base_path: nil,
-              api_version: '0.1',
-              markdown: nil,
-              hide_documentation_path: false,
-              hide_format: false,
-              format: nil,
-              models: [],
-              info: {},
-              authorizations: nil,
-              root_base_path: true,
-              api_documentation: { desc: 'Swagger compatible API description' },
-              specific_api_documentation: { desc: 'Swagger compatible API description for specific API' }
-            }
-
-            options = defaults.merge(options)
-
-            target_class     = options[:target_class]
-            @@mount_path     = options[:mount_path]
-            @@class_name     = options[:class_name] || options[:mount_path].gsub('/', '')
-            @@markdown       = options[:markdown] ? GrapeSwagger::Markdown.new(options[:markdown]) : nil
-            @@hide_format    = options[:hide_format]
-            api_version      = options[:api_version]
-            base_path        = options[:base_path]
-            authorizations   = options[:authorizations]
-            root_base_path   = options[:root_base_path]
-            extra_info       = options[:info]
-            api_doc          = options[:api_documentation].dup
-            specific_api_doc = options[:specific_api_documentation].dup
-            @@models         = options[:models] || []
-
-            @@hide_documentation_path = options[:hide_documentation_path]
-
-            if options[:format]
-              [:format, :default_format, :default_error_formatter].each do |method|
-                send(method, options[:format])
-              end
-            end
-
-            desc api_doc.delete(:desc), params: api_doc.delete(:params)
-            @last_description.merge!(api_doc)
-            get @@mount_path do
-              header['Access-Control-Allow-Origin']   = '*'
-              header['Access-Control-Request-Method'] = '*'
-
-              routes = target_class.combined_routes
-              namespaces = target_class.combined_namespaces
-
-              if @@hide_documentation_path
-                routes.reject! { |route, _value| "/#{route}/".index(parse_path(@@mount_path, nil) << '/') == 0 }
-              end
-
-              routes_array = routes.keys.map do |local_route|
-                next if routes[local_route].all?(&:route_hidden)
-
-                url_format  = '.{format}' unless @@hide_format
-
-                description = namespaces[local_route] && namespaces[local_route].options[:desc]
-                description ||= "Operations about #{local_route.pluralize}"
-
-                {
-                  path: "/#{local_route}#{url_format}",
-                  description: description
-                }
-              end.compact
-
-              output = {
-                apiVersion:     api_version,
-                swaggerVersion: '1.2',
-                produces:       content_types_for(target_class),
-                apis:           routes_array,
-                info:           parse_info(extra_info)
-              }
-
-              output[:authorizations] = authorizations unless authorizations.nil? || authorizations.empty?
-
-              output
-            end
-
-            desc specific_api_doc.delete(:desc), params: {
-              'name' => {
-                desc: 'Resource name of mounted API',
-                type: 'string',
-                required: true
-              }
-            }.merge(specific_api_doc.delete(:params) || {})
-            @last_description.merge!(specific_api_doc)
-            get "#{@@mount_path}/:name" do
-              header['Access-Control-Allow-Origin']   = '*'
-              header['Access-Control-Request-Method'] = '*'
-
-              models = []
-              routes = target_class.combined_routes[params[:name]]
-              error!('Not Found', 404) unless routes
-
-              ops = routes.reject(&:route_hidden).group_by do |route|
-                parse_path(route.route_path, api_version)
-              end
-
-              error!('Not Found', 404) unless ops.any?
-
-              apis = []
-
-              ops.each do |path, op_routes|
-                operations = op_routes.map do |route|
-                  notes       = as_markdown(route.route_notes)
-
-                  http_codes  = parse_http_codes(route.route_http_codes, models)
-
-                  models << @@models if @@models.present?
-
-                  models << route.route_entity if route.route_entity.present?
-
-                  models = models_with_included_presenters(models.flatten.compact)
-
-                  operation = {
-                    notes: notes.to_s,
-                    summary: route.route_description || '',
-                    nickname: route.route_nickname || (route.route_method + route.route_path.gsub(/[\/:\(\)\.]/, '-')),
-                    method: route.route_method,
-                    parameters: parse_header_params(route.route_headers) + parse_params(route.route_params, route.route_path, route.route_method),
-                    type: 'void'
-                  }
-                  operation[:authorizations] = route.route_authorizations unless route.route_authorizations.nil? || route.route_authorizations.empty?
-                  if operation[:parameters].any? { | param | param[:type] == 'File' }
-                    operation.merge!(consumes: ['multipart/form-data'])
-                  end
-                  operation.merge!(responseMessages: http_codes) unless http_codes.empty?
-
-                  if route.route_entity
-                    type = parse_entity_name(route.route_entity)
-                    if route.instance_variable_get(:@options)[:is_array]
-                      operation.merge!(
-                        'type' => 'array',
-                        'items' => generate_typeref(type)
-                      )
-                    else
-                      operation.merge!('type' => type)
-                    end
-                  end
-
-                  operation[:nickname] = route.route_nickname if route.route_nickname
-                  operation
-                end.compact
-                apis << {
-                  path: path,
-                  operations: operations
-                }
-              end
-
-              api_description = {
-                apiVersion:     api_version,
-                swaggerVersion: '1.2',
-                resourcePath:   "/#{params[:name]}",
-                produces:       content_types_for(target_class),
-                apis:           apis
-              }
-
-              base_path                        = parse_base_path(base_path, request)
-              api_description[:basePath]       = base_path if base_path && base_path.size > 0 && root_base_path != false
-              api_description[:models]         = parse_entity_models(models) unless models.empty?
-              api_description[:authorizations] = authorizations if authorizations
-
-              api_description
-            end
-          end
-
-          helpers do
 
             def as_markdown(description)
               description && @@markdown ? @@markdown.as_markdown(strip_heredoc(description)) : description
@@ -228,12 +63,23 @@ module Grape
 
             def parse_params(params, path, method)
               params ||= []
-              params.map do |param, value|
-                value[:type] = 'File' if value.is_a?(Hash) && ['Rack::Multipart::UploadedFile', 'Hash'].include?(value[:type])
+
+              non_nested_parent_params = params.reject do |param, _|
+                is_nested_param = /^#{ Regexp.quote param }\[.+\]$/
+                params.keys.any? { |p| p.match is_nested_param }
+              end
+
+              non_nested_parent_params.map do |param, value|
                 items = {}
 
                 raw_data_type = value.is_a?(Hash) ? (value[:type] || 'string').to_s : 'string'
                 data_type     = case raw_data_type
+                                when 'Hash'
+                                  'object'
+                                when 'Rack::Multipart::UploadedFile'
+                                  'File'
+                                when 'Virtus::Attribute::Boolean'
+                                  'boolean'
                                 when 'Boolean', 'Date', 'Integer', 'String'
                                   raw_data_type.downcase
                                 when 'BigDecimal'
@@ -243,7 +89,7 @@ module Grape
                                 when 'Numeric'
                                   'double'
                                 else
-                                  parse_entity_name(raw_data_type)
+                                  @@documentation_class.parse_entity_name(raw_data_type)
                                 end
                 description   = value.is_a?(Hash) ? value[:desc] || value[:description] : ''
                 required      = value.is_a?(Hash) ? !!value[:required] : false
@@ -292,10 +138,10 @@ module Grape
             end
 
             def content_types_for(target_class)
-              content_types = (target_class.settings[:content_types] || {}).values
+              content_types = (target_class.content_types || {}).values
 
               if content_types.empty?
-                formats       = [target_class.settings[:format], target_class.settings[:default_format]].compact.uniq
+                formats       = [target_class.format, target_class.default_format].compact.uniq
                 formats       = Grape::Formatter::Base.formatters({}).keys if formats.empty?
                 content_types = Grape::ContentTypes::CONTENT_TYPES.select { |content_type, _mime_type| formats.include? content_type }.values
               end
@@ -411,10 +257,18 @@ module Grape
 
               models.each do |model|
                 # get model references from exposures with a documentation
-                additional_models = model.exposures.map do |_, config|
-                  config[:using] if config.key?(:documentation)
+                nested_models = model.exposures.map do |_, config|
+                  if config.key?(:documentation)
+                    model = config[:using]
+                    model.respond_to?(:constantize) ? model.constantize : model
+                  end
                 end.compact
 
+                # get all nested models recursively
+                additional_models = nested_models.map do |nested_model|
+                  models_with_included_presenters([nested_model])
+                end.flatten
+
                 all_models += additional_models
               end
 
@@ -422,10 +276,11 @@ module Grape
             end
 
             def is_primitive?(type)
-              %w(integer long float double string byte boolean date dateTime).include? type
+              %w(object integer long float double string byte boolean date dateTime).include? type
             end
 
             def generate_typeref(type)
+              type = type.to_s.sub(/^[A-Z]/) { |f| f.downcase } if type.is_a?(Class)
               if is_primitive? type
                 { 'type' => type }
               else
@@ -446,14 +301,6 @@ module Grape
               end
             end
 
-            def try(*args, &block)
-              if args.empty? && block_given?
-                yield self
-              elsif respond_to?(args.first)
-                public_send(*args, &block)
-              end
-            end
-
             def strip_heredoc(string)
               indent = string.scan(/^[ \t]*(?=\S)/).min.try(:size) || 0
               string.gsub(/^[ \t]{#{indent}}/, '')
@@ -468,6 +315,177 @@ module Grape
                 request.base_url
               end
             end
+
+            def hide_documentation_path
+              @@hide_documentation_path
+            end
+
+            def mount_path
+              @@mount_path
+            end
+
+            def setup(options)
+              defaults = {
+                target_class: nil,
+                mount_path: '/swagger_doc',
+                base_path: nil,
+                api_version: '0.1',
+                markdown: nil,
+                hide_documentation_path: false,
+                hide_format: false,
+                format: nil,
+                models: [],
+                info: {},
+                authorizations: nil,
+                root_base_path: true,
+                api_documentation: { desc: 'Swagger compatible API description' },
+                specific_api_documentation: { desc: 'Swagger compatible API description for specific API' }
+              }
+
+              options = defaults.merge(options)
+
+              target_class     = options[:target_class]
+              @@mount_path     = options[:mount_path]
+              @@class_name     = options[:class_name] || options[:mount_path].gsub('/', '')
+              @@markdown       = options[:markdown] ? GrapeSwagger::Markdown.new(options[:markdown]) : nil
+              @@hide_format    = options[:hide_format]
+              api_version      = options[:api_version]
+              authorizations   = options[:authorizations]
+              root_base_path   = options[:root_base_path]
+              extra_info       = options[:info]
+              api_doc          = options[:api_documentation].dup
+              specific_api_doc = options[:specific_api_documentation].dup
+              @@models         = options[:models] || []
+
+              @@hide_documentation_path = options[:hide_documentation_path]
+
+              if options[:format]
+                [:format, :default_format, :default_error_formatter].each do |method|
+                  send(method, options[:format])
+                end
+              end
+
+              @@documentation_class = self
+
+              desc api_doc.delete(:desc), api_doc
+              get @@mount_path do
+                header['Access-Control-Allow-Origin']   = '*'
+                header['Access-Control-Request-Method'] = '*'
+
+                routes = target_class.combined_routes
+                namespaces = target_class.combined_namespaces
+
+                if @@hide_documentation_path
+                  routes.reject! { |route, _value| "/#{route}/".index(@@documentation_class.parse_path(@@mount_path, nil) << '/') == 0 }
+                end
+
+                routes_array = routes.keys.map do |local_route|
+                  next if routes[local_route].all?(&:route_hidden)
+
+                  url_format  = '.{format}' unless @@hide_format
+
+                  description = namespaces[local_route] && namespaces[local_route].options[:desc]
+                  description ||= "Operations about #{local_route.pluralize}"
+
+                  {
+                    path: "/#{local_route}#{url_format}",
+                    description: description
+                  }
+                end.compact
+
+                output = {
+                  apiVersion:     api_version,
+                  swaggerVersion: '1.2',
+                  produces:       @@documentation_class.content_types_for(target_class),
+                  apis:           routes_array,
+                  info:           @@documentation_class.parse_info(extra_info)
+                }
+
+                output[:authorizations] = authorizations unless authorizations.nil? || authorizations.empty?
+
+                output
+              end
+
+              desc specific_api_doc.delete(:desc), { params: {
+                'name' => {
+                  desc: 'Resource name of mounted API',
+                  type: 'string',
+                  required: true
+                }
+              }.merge(specific_api_doc.delete(:params) || {}) }.merge(specific_api_doc)
+
+              get "#{@@mount_path}/:name" do
+                header['Access-Control-Allow-Origin']   = '*'
+                header['Access-Control-Request-Method'] = '*'
+
+                models = []
+                routes = target_class.combined_routes[params[:name]]
+                error!('Not Found', 404) unless routes
+
+                ops = routes.reject(&:route_hidden).group_by do |route|
+                  @@documentation_class.parse_path(route.route_path, api_version)
+                end
+
+                error!('Not Found', 404) unless ops.any?
+
+                apis = []
+
+                ops.each do |path, op_routes|
+                  operations = op_routes.map do |route|
+                    notes       = @@documentation_class.as_markdown(route.route_notes)
+
+                    http_codes  = @@documentation_class.parse_http_codes(route.route_http_codes, models)
+
+                    models |= @@models if @@models.present?
+
+                    models |= [route.route_entity] if route.route_entity.present?
+
+                    models = @@documentation_class.models_with_included_presenters(models.flatten.compact)
+
+                    operation = {
+                      notes: notes.to_s,
+                      summary: route.route_description || '',
+                      nickname: route.route_nickname || (route.route_method + route.route_path.gsub(/[\/:\(\)\.]/, '-')),
+                      method: route.route_method,
+                      parameters: @@documentation_class.parse_header_params(route.route_headers) + @@documentation_class.parse_params(route.route_params, route.route_path, route.route_method),
+                      type: 'void'
+                    }
+                    operation[:authorizations] = route.route_authorizations unless route.route_authorizations.nil? || route.route_authorizations.empty?
+                    if operation[:parameters].any? { | param | param[:type] == 'File' }
+                      operation.merge!(consumes: ['multipart/form-data'])
+                    end
+                    operation.merge!(responseMessages: http_codes) unless http_codes.empty?
+
+                    if route.route_entity
+                      type = @@documentation_class.parse_entity_name(route.route_entity)
+                      operation.merge!('type' => type)
+                    end
+
+                    operation[:nickname] = route.route_nickname if route.route_nickname
+                    operation
+                  end.compact
+                  apis << {
+                    path: path,
+                    operations: operations
+                  }
+                end
+
+                api_description = {
+                  apiVersion:     api_version,
+                  swaggerVersion: '1.2',
+                  resourcePath:   "/#{params[:name]}",
+                  produces:       @@documentation_class.content_types_for(target_class),
+                  apis:           apis
+                }
+
+                base_path                        = @@documentation_class.parse_base_path(options[:base_path], request)
+                api_description[:basePath]       = base_path if base_path && base_path.size > 0 && root_base_path != false
+                api_description[:models]         = @@documentation_class.parse_entity_models(models) unless models.empty?
+                api_description[:authorizations] = authorizations if authorizations
+
+                api_description
+              end
+            end
           end
         end
       end