Class: SwaggerParser::Swagger

Inherits:
SourceBasedObject show all
Includes:
ExternalDocsAttributable
Defined in:
lib/swagger_parser/swagger.rb

Instance Attribute Summary

Attributes inherited from SourceBasedObject

#source

Instance Method Summary collapse

Methods included from ExternalDocsAttributable

#external_docs

Methods inherited from SourceBasedObject

#initialize

Constructor Details

This class inherits a constructor from SwaggerParser::SourceBasedObject

Instance Method Details

#base_path ⇒ Object

Returns:

  • (Object) 


17
18
19
 
# File 'lib/swagger_parser/swagger.rb', line 17

def base_path
  source["basePath"]
end

#consumes ⇒ Object

Returns:

  • (Object) 


22
23
24
 
# File 'lib/swagger_parser/swagger.rb', line 22

def consumes
  source["consumes"] || []
end

#definitions ⇒ SwaggerParser::Definitions

Returns:



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

def definitions
  SwaggerParser::Definitions.new(source["definitions"] || {})
end

#errors ⇒ Array<SwaggerParser::Error>

Returns:

  • (Array<SwaggerParser::Error>) 


32
33
34
 
# File 'lib/swagger_parser/swagger.rb', line 32

def errors
  @__errors ||= []
end

#host ⇒ Object

Returns:

  • (Object) 


37
38
39
 
# File 'lib/swagger_parser/swagger.rb', line 37

def host
  source["host"]
end

#info ⇒ SwaggerParser::Info

Returns:



42
43
44
 
# File 'lib/swagger_parser/swagger.rb', line 42

def info
  SwaggerParser::Info.new(source["info"])
end

#parameters ⇒ SwaggerParser::Parameters

Returns:



47
48
49
 
# File 'lib/swagger_parser/swagger.rb', line 47

def parameters
  SwaggerParser::Parameters.new(source["parameters"] || {})
end

#paths ⇒ SwaggerParser::Paths

Returns:



52
53
54
 
# File 'lib/swagger_parser/swagger.rb', line 52

def paths
  SwaggerParser::Paths.new(source["paths"])
end

#produces ⇒ Object

Returns:

  • (Object) 


57
58
59
 
# File 'lib/swagger_parser/swagger.rb', line 57

def produces
  source["produces"] || []
end

#responses ⇒ SwaggerParser::ResponseDefinitions

Returns:



62
63
64
 
# File 'lib/swagger_parser/swagger.rb', line 62

def responses
  SwaggerParser::ResponseDefinitions.new(source["responses"] || {})
end

#schemes ⇒ Object

Returns:

  • (Object) 


67
68
69
 
# File 'lib/swagger_parser/swagger.rb', line 67

def schemes
  source["schemes"]
end

#security ⇒ SwaggerParser::Security

Returns:



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

def security
  SwaggerParser::Security.new(source["security"] || {})
end

#security_definitions ⇒ SwaggerParser::SecurityDefinitions

Returns:



77
78
79
 
# File 'lib/swagger_parser/swagger.rb', line 77

def security_definitions
  SwaggerParser::SecurityDefinitions.new(source["securityDefinitions"] || {})
end

#swagger ⇒ Object

Returns:

  • (Object) 


82
83
84
 
# File 'lib/swagger_parser/swagger.rb', line 82

def swagger
  source["swagger"]
end

#tags ⇒ Array<SwaggerParser::Tag>

Returns:



87
88
89
90
91
 
# File 'lib/swagger_parser/swagger.rb', line 87

def tags
  (source["tags"] || []).map do |element|
    SwaggerParser::Tag.new(element)
  end
end

#valid? ⇒ false, true

Returns:

  • (false, true) 


94
95
96
97
 
# File 'lib/swagger_parser/swagger.rb', line 94

def valid?
  collect_errors
  errors.empty?
end