Module: OpenapiRuby

Defined in:
lib/openapi_ruby.rb,
lib/openapi_ruby/engine.rb,
lib/openapi_ruby/errors.rb,
lib/openapi_ruby/version.rb,
lib/openapi_ruby/dsl/context.rb,
lib/openapi_ruby/configuration.rb,
lib/openapi_ruby/core/document.rb,
lib/openapi_ruby/adapters/rspec.rb,
lib/openapi_ruby/components/base.rb,
lib/openapi_ruby/testing/coverage.rb,
lib/openapi_ruby/adapters/minitest.rb,
lib/openapi_ruby/components/loader.rb,
lib/openapi_ruby/core/ref_resolver.rb,
lib/openapi_ruby/controller_helpers.rb,
lib/openapi_ruby/dsl/metadata_store.rb,
lib/openapi_ruby/testing/assertions.rb,
lib/openapi_ruby/components/registry.rb,
lib/openapi_ruby/middleware/coercion.rb,
lib/openapi_ruby/dsl/response_context.rb,
lib/openapi_ruby/core/document_builder.rb,
lib/openapi_ruby/dsl/operation_context.rb,
lib/openapi_ruby/generator/schema_writer.rb,
lib/openapi_ruby/middleware/path_matcher.rb,
lib/openapi_ruby/testing/request_builder.rb,
lib/openapi_ruby/middleware/error_handler.rb,
app/controllers/openapi_ruby/ui_controller.rb,
lib/openapi_ruby/testing/request_validator.rb,
lib/openapi_ruby/components/key_transformer.rb,
lib/openapi_ruby/middleware/schema_resolver.rb,
lib/openapi_ruby/testing/response_validator.rb,
lib/openapi_ruby/generator/rake_task_support.rb,
lib/openapi_ruby/middleware/request_validation.rb,
app/controllers/openapi_ruby/schemas_controller.rb,
lib/openapi_ruby/middleware/response_validation.rb,
lib/generators/openapi_ruby/install/install_generator.rb,
lib/generators/openapi_ruby/component/component_generator.rb

Defined Under Namespace

Modules: Adapters, Components, ControllerHelpers, Core, DSL, Generator, Generators, Middleware, Testing Classes: Configuration, ConfigurationError, DuplicateComponentError, Engine, Error, InvalidDocumentError, RequestValidationError, ResponseValidationError, SchemaValidationError, SchemasController, UiController

Constant Summary collapse

VERSION = 
"3.5.0"

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object 



19
20
21
 
# File 'lib/openapi_ruby.rb', line 19

def configuration
  @configuration ||= Configuration.new
end

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

Yields:



23
24
25
 
# File 'lib/openapi_ruby.rb', line 23

def configure
  yield(configuration)
end

.reset_configuration! ⇒ Object 



27
28
29
 
# File 'lib/openapi_ruby.rb', line 27

def reset_configuration!
  @configuration = Configuration.new
end

.schema_generating? ⇒ Boolean

True when the current process was started by ‘openapi_ruby:generate` (the rake task sets OPENAPI_RUBY_GENERATING=true in the subprocess).

Useful in consumer test helpers to guard test-framework requires that conflict when both ‘rspec/rails` and `rails/test_help` load in the same process (the FRAMEWORK=hybrid case):

# test/test_helper.rb
unless OpenapiRuby.schema_generating?
  require "rails/test_help"
  # ...other test-time setup...
end

Returns:

  • (Boolean) 


43
44
45
 
# File 'lib/openapi_ruby.rb', line 43

def schema_generating?
  ENV["OPENAPI_RUBY_GENERATING"] == "true"
end