class SwaggerParser::Swagger

Public Instance Methods

base_path() click to toggle source

@return [Object]

# File lib/swagger_parser/swagger.rb, line 17
def base_path
  source["basePath"]
end
consumes() click to toggle source

@return [Object]

# File lib/swagger_parser/swagger.rb, line 22
def consumes
  source["consumes"] || []
end
definitions() click to toggle source

@return [SwaggerParser::Definitions]

# File lib/swagger_parser/swagger.rb, line 27
def definitions
  SwaggerParser::Definitions.new(source["definitions"] || {})
end
errors() click to toggle source

@return [Array<SwaggerParser::Error>]

# File lib/swagger_parser/swagger.rb, line 32
def errors
  @__errors ||= []
end
host() click to toggle source

@return [Object]

# File lib/swagger_parser/swagger.rb, line 37
def host
  source["host"]
end
info() click to toggle source

@return [SwaggerParser::Info]

# File lib/swagger_parser/swagger.rb, line 42
def info
  SwaggerParser::Info.new(source["info"])
end
parameters() click to toggle source

@return [SwaggerParser::Parameters]

# File lib/swagger_parser/swagger.rb, line 47
def parameters
  SwaggerParser::Parameters.new(source["parameters"] || {})
end
paths() click to toggle source

@return [SwaggerParser::Paths]

# File lib/swagger_parser/swagger.rb, line 52
def paths
  SwaggerParser::Paths.new(source["paths"])
end
produces() click to toggle source

@return [Object]

# File lib/swagger_parser/swagger.rb, line 57
def produces
  source["produces"] || []
end
responses() click to toggle source

@return [SwaggerParser::ResponseDefinitions]

# File lib/swagger_parser/swagger.rb, line 62
def responses
  SwaggerParser::ResponseDefinitions.new(source["responses"] || {})
end
schemes() click to toggle source

@return [Object]

# File lib/swagger_parser/swagger.rb, line 67
def schemes
  source["schemes"]
end
security() click to toggle source

@return [SwaggerParser::Security]

# File lib/swagger_parser/swagger.rb, line 72
def security
  SwaggerParser::Security.new(source["security"] || {})
end
security_definitions() click to toggle source

@return [SwaggerParser::SecurityDefinitions]

# File lib/swagger_parser/swagger.rb, line 77
def security_definitions
  SwaggerParser::SecurityDefinitions.new(source["securityDefinitions"] || {})
end
swagger() click to toggle source

@return [Object]

# File lib/swagger_parser/swagger.rb, line 82
def swagger
  source["swagger"]
end
tags() click to toggle source

@return [Array<SwaggerParser::Tag>]

# File lib/swagger_parser/swagger.rb, line 87
def tags
  (source["tags"] || []).map do |element|
    SwaggerParser::Tag.new(element)
  end
end
valid?() click to toggle source

@return [false, true]

# File lib/swagger_parser/swagger.rb, line 94
def valid?
  collect_errors
  errors.empty?
end

Private Instance Methods

collect_errors() click to toggle source
# File lib/swagger_parser/swagger.rb, line 101
def collect_errors
  unless has_hash_source?
    errors |= SwaggerParser::Error.new("Swagger source is not a Hash")
  end
end
has_hash_source?() click to toggle source

@return [false, true]

# File lib/swagger_parser/swagger.rb, line 108
def has_hash_source?
  source.is_a?(Hash)
end