Module: Jsonapi::Swagger

Defined in:
lib/jsonapi/swagger.rb,
lib/jsonapi/swagger/json.rb,
lib/jsonapi/swagger/railtie.rb,
lib/jsonapi/swagger/version.rb,
lib/jsonapi/swagger/resource.rb,
lib/jsonapi/swagger/resources/jsonapi_resource.rb,
lib/jsonapi/swagger/resources/fast_jsonapi_resource.rb,
lib/jsonapi/swagger/resources/serializable_resource.rb

Defined Under Namespace

Classes: Error, FastJsonapiResource, Json, JsonapiResource, Railtie, Resource, SerializableResource

Constant Summary collapse

VERSION = 
'0.8.1'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.base_path ⇒ Object

Returns the value of attribute base_path.



13
14
15
 
# File 'lib/jsonapi/swagger.rb', line 13

def base_path
  @base_path
end

.file_path ⇒ Object

Returns the value of attribute file_path.



13
14
15
 
# File 'lib/jsonapi/swagger.rb', line 13

def file_path
  @file_path
end

.info ⇒ Object

Returns the value of attribute info.



13
14
15
 
# File 'lib/jsonapi/swagger.rb', line 13

def info
  @info
end

.use_rswag ⇒ Object

Returns the value of attribute use_rswag.



13
14
15
 
# File 'lib/jsonapi/swagger.rb', line 13

def use_rswag
  @use_rswag
end

.version ⇒ Object

Returns the value of attribute version.



13
14
15
 
# File 'lib/jsonapi/swagger.rb', line 13

def version
  @version
end

Class Method Details

.attribute_default ⇒ Object 



39
40
41
 
# File 'lib/jsonapi/swagger.rb', line 39

def attribute_default
  @attribute_default ||= { type: :string, nullable: true, comment: nil }
end

.config {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:



15
16
17
 
# File 'lib/jsonapi/swagger.rb', line 15

def config
  yield self
end