Module: SwaggerModel::OpenAPIv3

Defined in:
lib/swagger_model.rb

Class Method Summary collapse

Class Method Details

.create_from_json(params) ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/swagger_model.rb', line 148

def self.create_from_json(params)
  response = {}.to_json
  json_string = params[:json_string]
  if !json_string.nil?
    response = JSON.load(json_string)
  else
    json_file_path = params[:json_file_path] || gets
    json = open(json_file_path) do |io|
      JSON.load(io)
    end
    response = json
  end
  response_name = params[:response_name] || gets
  response_model = {}
  response_model[response_name] = {}
  response_model[response_name]['type'] = "object"
  model = {}
  object = parse_object(response, model, response_name)
  properties = object['properties']
  if properties.has_key?('links')
    links = {}
    links['$ref'] = '#/components/schemas/Links'
    properties['links'] = links
  end
  if properties.has_key?('meta')
    meta_name = response_name + 'Meta'
    response_model[meta_name] = properties['meta']
    meta = {}
    meta['$ref'] = '#/components/schemas/' + meta_name
    properties['meta'] = meta
  end
  response_model[response_name]['properties'] = properties
  if object['required'].size > 0
    response_model[response_name]['required'] = object['required']
  end
  output_path = params[:output_path] || './'
  output_path_responses = File.join(output_path, 'Responses/')
  output_path_models = File.join(output_path, 'Models/')

  FileUtils::mkdir_p output_path_responses
  FileUtils::mkdir_p output_path_models

  File.write(File.join(output_path_responses, "#{response_name}.yaml"), response_model.to_yaml)

  keys = model.keys
  for key in keys do
    File.write(File.join(output_path_models, "#{key}.yaml"), model[key].to_yaml)
  end
end

.date_time_valid?(str) ⇒ Boolean

Returns:

  • (Boolean) 


20
21
22
23
24
25
26
27
 
# File 'lib/swagger_model.rb', line 20

def self.date_time_valid?(str)
  if (!! Date.parse(str) rescue false)
    date = Date._parse(str)
    !date[:zone].nil? && !date[:hour].nil? && !date[:min].nil? && !date[:sec].nil? && !date[:year].nil? && !date[:mon].nil?
  else
    false
  end
end

.get_property(key, value, model, root_key) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/swagger_model.rb', line 29

def self.get_property(key, value, model, root_key)
  type_class = value.class.to_s
  obj = {}
  case type_class
  when 'Hash'
    if value.has_key?('id') && value.has_key?('type')
      model_name = ActiveSupport::Inflector.classify(value['type'].gsub('-', '_'))
      model[model_name] = {}
      object = parse_object(value, model, model_name)
      properties = object['properties']
      newProperties = {}
      newProperties['allOf'] = []
      newProperties['allOf'][0] = {}
      newProperties['allOf'][0]['$ref'] = '#/components/schemas/ModelBase'
      newProperties['allOf'][1] = {}
      newProperties['allOf'][1]['type'] = 'object'
      if object['required'].size > 0
          newProperties['allOf'][1]['required'] = object['required']
      end
      properties.delete('id')
      properties.delete('type')
      newProperties['allOf'][1]['properties'] = properties
      model[model_name][model_name] = newProperties
      obj['$ref'] = '#/components/schemas/' + model_name
    elsif key == 'attributes'
      object = parse_object(value, model, root_key)
      properties = object['properties']
      model_name = root_key + 'Attributes'
      model[root_key][model_name] = {}
      model[root_key][model_name]['type'] = 'object'
      model[root_key][model_name]['properties'] = properties
      if object['required'].size > 0
        model[root_key][model_name]['required'] = object['required']
      end
      obj['$ref'] = '#/components/schemas/' + model_name
    elsif key == 'relationships'
      object = parse_object(value, model, root_key)
      properties = object['properties']
      model_name = root_key + 'Relationships'
      model[root_key][model_name] = {}
      model[root_key][model_name]['type'] = 'object'
      model[root_key][model_name]['properties'] = properties
      if object['required'].size > 0
        model[root_key][model_name]['required'] = object['required']
      end
      obj['$ref'] = '#/components/schemas/' + model_name
    else
      object = parse_object(value, model, root_key)
      properties = object['properties']
      obj['type'] = 'object'
      obj['properties'] = properties
      if object['required'].size > 0
        obj['required'] = object['required']
      end
    end
  when 'Array'
    if key == 'included'
      obj['type'] = 'array'
      obj['items'] = {}
      obj['items']['oneOf'] = parse_array_with_multi_model(value, model, root_key)
    else
      obj['type'] = 'array'
      obj['items'] = parse_array(value, model, root_key)
    end
  when 'String'
    obj['type'] = 'string'
    obj['example'] = value
    if date_time_valid?(value)
      obj['format'] = 'date-time'
    end
  when 'Fixnum'
    obj['type'] = 'integer'
    obj['example'] = value
  when 'TrueClass', 'FalseClass'
    obj['type'] = 'boolean'
    obj['example'] = value
  when 'Float'
    obj['type'] = 'number'
    obj['format'] = 'float'
    obj['example'] = value
  else
    obj['type'] = ''
    obj['example'] = ''
  end
  obj
end

.parse_array(items, model, root_key) ⇒ Object 



116
117
118
119
120
 
# File 'lib/swagger_model.rb', line 116

def self.parse_array(items, model, root_key)
  m = {}
  value = items.first
  get_property(nil, value, model, root_key)
end

.parse_array_with_multi_model(items, model, root_key) ⇒ Object 



122
123
124
125
126
127
128
 
# File 'lib/swagger_model.rb', line 122

def self.parse_array_with_multi_model(items, model, root_key)
  types = []
  items.each do |value|
    types.push(get_property(nil, value, model, root_key))
  end
  types
end

.parse_object(res, model, root_key) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/swagger_model.rb', line 130

def self.parse_object(res, model, root_key)
  keys = res.keys
  m = {}
  required = []
  for key in keys do
    value = res[key]
    m[key] = get_property(key, value, model, root_key)
    if m[key]['type'] != ''
      unless (keys.include?('id') && keys.include?('type')) && (key == 'id' || key == 'type')
        required.push(key)
      end
    end
  end
  obj = {}
  obj['properties'] = m
  obj['required'] = required
  obj
end