Module: Apiture

Defined in:

lib/apiture/swagger/specification.rb,
lib/apiture.rb,
lib/apiture/uri.rb,
lib/apiture/version.rb,
lib/apiture/api_base.rb,
lib/apiture/api_base.rb,
lib/apiture/endpoint.rb,
lib/apiture/api_error.rb,
lib/apiture/api_group.rb,
lib/apiture/api_builder.rb,
lib/apiture/swagger/info.rb,
lib/apiture/swagger/node.rb,
lib/apiture/swagger/path.rb,
lib/apiture/swagger/parser.rb,
lib/apiture/request_context.rb,
lib/apiture/middleware/debug.rb,
lib/apiture/middleware_stack.rb,
lib/apiture/swagger/property.rb,
lib/apiture/swagger/security.rb,
lib/apiture/swagger/operation.rb,
lib/apiture/swagger/parameter.rb,
lib/apiture/utils/inflections.rb,
lib/apiture/middleware_builder.rb,
lib/apiture/middleware/auth/basic.rb,
lib/apiture/middleware/set_header.rb,
lib/apiture/swagger/external_docs.rb,
lib/apiture/middleware/auth/oauth2.rb,
lib/apiture/middleware/auth/api_key.rb,
lib/apiture/swagger/data_type_field.rb,
lib/apiture/swagger/array_definition.rb,
lib/apiture/definition_value_renderer.rb,
lib/apiture/swagger/object_definition.rb,
lib/apiture/swagger/security_definition.rb,
lib/apiture/middleware/convert_json_body.rb,
lib/apiture/swagger/definition_reference.rb,
lib/apiture/middleware/set_body_parameter.rb,
lib/apiture/middleware/set_form_parameter.rb,
lib/apiture/middleware/set_parameter_base.rb,
lib/apiture/middleware/set_path_parameter.rb,
lib/apiture/middleware/set_query_parameter.rb

Overview

require ‘apiture/swagger/response’

Defined Under Namespace

Modules: Middleware, Swagger, Utils Classes: APIBase, APIBuilder, APIError, APIGroup, DefinitionValueRenderer, Endpoint, MiddlewareBuilder, MiddlewareStack, RequestContext, URI

Constant Summary

VERSION =

"0.2.6"

Class Method Summary

• .build_api(specification) ⇒ Object
• .load_api(path) ⇒ Object
• .parse_specification(path) ⇒ Object

Class Method Details

.build_api(specification) ⇒ Object

# File 'lib/apiture.rb', line 16

def self.build_api(specification)
  Apiture::APIBuilder.new(specification).build
end

.load_api(path) ⇒ Object

# File 'lib/apiture.rb', line 20

def self.load_api(path)
  build_api(parse_specification(path))
end

.parse_specification(path) ⇒ Object

# File 'lib/apiture.rb', line 8

def self.parse_specification(path)
  if path.match(/\.yml$/)
    Apiture::Swagger::Parser.new.parse_yaml(File.read(path))
  else
    Apiture::Swagger::Parser.new.parse_json(File.read(path))
  end
end