Module: RailsApiDoc

Defined in:
lib/rails_api_doc.rb,
lib/rails_api_doc/railtie.rb,
lib/rails_api_doc/version.rb,
lib/rails_api_doc/controller/param.rb,
lib/rails_api_doc/controller/headers.rb,
lib/rails_api_doc/controller/request/dsl.rb,
lib/rails_api_doc/controller/request/param.rb,
lib/rails_api_doc/exception/param_required.rb,
app/models/rails_api_doc/application_record.rb,
lib/rails_api_doc/controller/response/param.rb,
app/helpers/rails_api_doc/application_helper.rb,
lib/rails_api_doc/controller/request/headers.rb,
lib/generators/rails_api_doc/install_generator.rb,
lib/rails_api_doc/controller/strong_params/dsl.rb,
app/controllers/rails_api_doc/application_controller.rb,
lib/rails_api_doc/controller/strong_params/permitted_params.rb

Overview

author: Vadim Shaveiko <@vshaveyko> frozen_string_literal: true

Defined Under Namespace

Modules: ApplicationHelper, Controller, Exception, Model Classes: ApiDatum, ApiDocsController, ApplicationController, ApplicationRecord, Config, Engine, InstallGenerator, Railtie

Constant Summary collapse

NESTED_TYPES = 
[:ary_object, :object, :json].freeze
STRAIGHT_TYPES = 
[:bool, :string, :integer, :array, :datetime, :enum, :model].freeze
ACCEPTED_TYPES = 
(NESTED_TYPES + STRAIGHT_TYPES).freeze
VERSION = 
'0.3.2'

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object 



76
77
78
 
# File 'lib/rails_api_doc.rb', line 76

def configuration
  @_configuration ||= Config.new
end

.configure {|configuration| ... } ⇒ Object

Yields:



72
73
74
 
# File 'lib/rails_api_doc.rb', line 72

def configure
  yield configuration
end

.reset_configuration ⇒ Object 



80
81
82
 
# File 'lib/rails_api_doc.rb', line 80

def reset_configuration
  @_configuration = nil
end