1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
|
# Asterisk -- An open source telephony toolkit.
#
# Copyright (C) 2013, Digium, Inc.
#
# David M. Lee, II <dlee@digium.com>
#
# See http://www.asterisk.org for more information about
# the Asterisk project. Please do not directly contact
# any of the maintainers of this project for assistance;
# the project provides a web site, mailing lists and IRC
# channels for your use.
#
# This program is free software, distributed under the terms of
# the GNU General Public License Version 2. See the LICENSE file
# at the top of the source tree.
#
"""Swagger data model objects.
These objects should map directly to the Swagger api-docs, without a lot of
additional fields. In the process of translation, it should also validate the
model for consistency against the Swagger spec (i.e., fail if fields are
missing, or have incorrect values).
See https://github.com/wordnik/swagger-core/wiki/API-Declaration for the spec.
"""
import json
import os.path
import pprint
import sys
import traceback
try:
from collections import OrderedDict
except ImportError:
from odict import OrderedDict
SWAGGER_VERSION = "1.1"
class SwaggerError(Exception):
"""Raised when an error is encountered mapping the JSON objects into the
model.
"""
def __init__(self, msg, context, cause=None):
"""Ctor.
@param msg: String message for the error.
@param context: Array of strings for current context in the API.
@param cause: Optional exception that caused this one.
"""
super(Exception, self).__init__(msg, context, cause)
class SwaggerPostProcessor(object):
"""Post processing interface for model objects. This processor can add
fields to model objects for additional information to use in the
templates.
"""
def process_api(self, resource_api, context):
"""Post process a ResourceApi object.
@param resource_api: ResourceApi object.
@param contect: Current context in the API.
"""
pass
def process_operation(self, operation, context):
"""Post process a Operation object.
@param operation: Operation object.
@param contect: Current context in the API.
"""
pass
def process_parameter(self, parameter, context):
"""Post process a Parameter object.
@param parameter: Parameter object.
@param contect: Current context in the API.
"""
pass
class Stringify(object):
"""Simple mix-in to make the repr of the model classes more meaningful.
"""
def __repr__(self):
return "%s(%s)" % (self.__class__, pprint.saferepr(self.__dict__))
class AllowableRange(Stringify):
"""Model of a allowableValues of type RANGE
See https://github.com/wordnik/swagger-core/wiki/datatypes#complex-types
"""
def __init__(self, min_value, max_value):
self.min_value = min_value
self.max_value = max_value
class AllowableList(Stringify):
"""Model of a allowableValues of type LIST
See https://github.com/wordnik/swagger-core/wiki/datatypes#complex-types
"""
def __init__(self, values):
self.values = values
def load_allowable_values(json, context):
"""Parse a JSON allowableValues object.
This returns None, AllowableList or AllowableRange, depending on the
valueType in the JSON. If the valueType is not recognized, a SwaggerError
is raised.
"""
if not json:
return None
if not 'valueType' in json:
raise SwaggerError("Missing valueType field", context)
value_type = json['valueType']
if value_type == 'RANGE':
if not 'min' in json:
raise SwaggerError("Missing field min", context)
if not 'max' in json:
raise SwaggerError("Missing field max", context)
return AllowableRange(json['min'], json['max'])
if value_type == 'LIST':
if not 'values' in json:
raise SwaggerError("Missing field values", context)
return AllowableList(json['values'])
raise SwaggerError("Unkown valueType %s" % value_type, context)
class Parameter(Stringify):
"""Model of an operation's parameter.
See https://github.com/wordnik/swagger-core/wiki/parameters
"""
required_fields = ['name', 'paramType', 'dataType']
def __init__(self):
self.param_type = None
self.name = None
self.description = None
self.data_type = None
self.required = None
self.allowable_values = None
self.allow_multiple = None
def load(self, parameter_json, processor, context):
context = add_context(context, parameter_json, 'name')
validate_required_fields(parameter_json, self.required_fields, context)
self.name = parameter_json.get('name')
self.param_type = parameter_json.get('paramType')
self.description = parameter_json.get('description') or ''
self.data_type = parameter_json.get('dataType')
self.required = parameter_json.get('required') or False
self.allowable_values = load_allowable_values(
parameter_json.get('allowableValues'), context)
self.allow_multiple = parameter_json.get('allowMultiple') or False
processor.process_parameter(self, context)
return self
def is_type(self, other_type):
return self.param_type == other_type
class ErrorResponse(Stringify):
"""Model of an error response.
See https://github.com/wordnik/swagger-core/wiki/errors
"""
required_fields = ['code', 'reason']
def __init__(self):
self.code = None
self.reason = None
def load(self, err_json, processor, context):
context = add_context(context, err_json, 'code')
validate_required_fields(err_json, self.required_fields, context)
self.code = err_json.get('code')
self.reason = err_json.get('reason')
return self
class Operation(Stringify):
"""Model of an operation on an API
See https://github.com/wordnik/swagger-core/wiki/API-Declaration#apis
"""
required_fields = ['httpMethod', 'nickname', 'responseClass', 'summary']
def __init__(self):
self.http_method = None
self.nickname = None
self.response_class = None
self.parameters = []
self.summary = None
self.notes = None
self.error_responses = []
def load(self, op_json, processor, context):
context = add_context(context, op_json, 'nickname')
validate_required_fields(op_json, self.required_fields, context)
self.http_method = op_json.get('httpMethod')
self.nickname = op_json.get('nickname')
self.response_class = op_json.get('responseClass')
params_json = op_json.get('parameters') or []
self.parameters = [
Parameter().load(j, processor, context) for j in params_json]
self.query_parameters = [
p for p in self.parameters if p.is_type('query')]
self.has_query_parameters = self.query_parameters and True
self.path_parameters = [
p for p in self.parameters if p.is_type('path')]
self.has_path_parameters = self.path_parameters and True
self.header_parameters = [
p for p in self.parameters if p.is_type('header')]
self.has_header_parameters = self.header_parameters and True
self.has_parameters = self.has_query_parameters or \
self.has_path_parameters or self.has_header_parameters
self.summary = op_json.get('summary')
self.notes = op_json.get('notes')
err_json = op_json.get('errorResponses') or []
self.error_responses = [
ErrorResponse().load(j, processor, context) for j in err_json]
processor.process_operation(self, context)
return self
class Api(Stringify):
"""Model of a single API in an API declaration.
See https://github.com/wordnik/swagger-core/wiki/API-Declaration
"""
required_fields = ['path', 'operations']
def __init__(self,):
self.path = None
self.description = None
self.operations = []
def load(self, api_json, processor, context):
context = add_context(context, api_json, 'path')
validate_required_fields(api_json, self.required_fields, context)
self.path = api_json.get('path')
self.description = api_json.get('description')
op_json = api_json.get('operations')
self.operations = [
Operation().load(j, processor, context) for j in op_json]
return self
class Property(Stringify):
"""Model of a Swagger property.
See https://github.com/wordnik/swagger-core/wiki/datatypes
"""
required_fields = ['type']
def __init__(self, name):
self.name = name
self.type = None
self.description = None
self.required = None
def load(self, property_json, processor, context):
validate_required_fields(property_json, self.required_fields, context)
self.type = property_json.get('type')
self.description = property_json.get('description') or ''
self.required = property_json.get('required') or False
return self
class Model(Stringify):
"""Model of a Swagger model.
See https://github.com/wordnik/swagger-core/wiki/datatypes
"""
def __init__(self):
self.id = None
self.properties = None
def load(self, id, model_json, processor, context):
context = add_context(context, model_json, 'id')
self.id = model_json.get('id')
if id != self.id:
raise SwaggerError("Model id doesn't match name", c)
props = model_json.get('properties').items() or []
self.properties = [
Property(k).load(j, processor, context) for (k, j) in props]
return self
class ApiDeclaration(Stringify):
"""Model class for an API Declaration.
See https://github.com/wordnik/swagger-core/wiki/API-Declaration
"""
required_fields = [
'swaggerVersion', '_author', '_copyright', 'apiVersion', 'basePath',
'resourcePath', 'apis', 'models'
]
def __init__(self):
self.swagger_version = None
self.author = None
self.copyright = None
self.api_version = None
self.base_path = None
self.resource_path = None
self.apis = []
self.models = []
def load_file(self, api_declaration_file, processor, context=[]):
context = context + [api_declaration_file]
try:
return self.__load_file(api_declaration_file, processor, context)
except SwaggerError:
raise
except Exception as e:
print >> sys.stderr, "Error: ", traceback.format_exc()
raise SwaggerError(
"Error loading %s" % api_declaration_file, context, e)
def __load_file(self, api_declaration_file, processor, context):
with open(api_declaration_file) as fp:
self.load(json.load(fp), processor, context)
expected_resource_path = '/api-docs/' + \
os.path.basename(api_declaration_file) \
.replace(".json", ".{format}")
if self.resource_path != expected_resource_path:
print "%s != %s" % (self.resource_path, expected_resource_path)
raise SwaggerError("resourcePath has incorrect value", context)
return self
def load(self, api_decl_json, processor, context):
"""Loads a resource from a single Swagger resource.json file.
"""
# If the version doesn't match, all bets are off.
self.swagger_version = api_decl_json.get('swaggerVersion')
if self.swagger_version != SWAGGER_VERSION:
raise SwaggerError(
"Unsupported Swagger version %s" % swagger_version, context)
validate_required_fields(api_decl_json, self.required_fields, context)
self.author = api_decl_json.get('_author')
self.copyright = api_decl_json.get('_copyright')
self.api_version = api_decl_json.get('apiVersion')
self.base_path = api_decl_json.get('basePath')
self.resource_path = api_decl_json.get('resourcePath')
api_json = api_decl_json.get('apis') or []
self.apis = [
Api().load(j, processor, context) for j in api_json]
models = api_decl_json.get('models').items() or []
self.models = [
Model().load(k, j, processor, context) for (k, j) in models]
return self
class ResourceApi(Stringify):
"""Model of an API listing in the resources.json file.
"""
required_fields = ['path', 'description']
def __init__(self):
self.path = None
self.description = None
self.api_declaration = None
def load(self, api_json, processor, context):
context = add_context(context, api_json, 'path')
validate_required_fields(api_json, self.required_fields, context)
self.path = api_json['path']
self.description = api_json['description']
if not self.path or self.path[0] != '/':
raise SwaggerError("Path must start with /", context)
processor.process_api(self, context)
return self
def load_api_declaration(self, base_dir, processor):
self.file = (base_dir + self.path).replace('{format}', 'json')
self.api_declaration = ApiDeclaration().load_file(self.file, processor)
processor.process_api(self, [self.file])
class ResourceListing(Stringify):
"""Model of Swagger's resources.json file.
"""
required_fields = ['apiVersion', 'basePath', 'apis']
def __init__(self):
self.swagger_version = None
self.api_version = None
self.base_path = None
self.apis = None
def load_file(self, resource_file, processor):
context = [resource_file]
try:
return self.__load_file(resource_file, processor, context)
except SwaggerError:
raise
except Exception as e:
print >> sys.stderr, "Error: ", traceback.format_exc()
raise SwaggerError(
"Error loading %s" % resource_file, context, e)
def __load_file(self, resource_file, processor, context):
with open(resource_file) as fp:
return self.load(json.load(fp), processor, context)
def load(self, resources_json, processor, context):
# If the version doesn't match, all bets are off.
self.swagger_version = resources_json.get('swaggerVersion')
if self.swagger_version != SWAGGER_VERSION:
raise SwaggerError(
"Unsupported Swagger version %s" % swagger_version, context)
validate_required_fields(resources_json, self.required_fields, context)
self.api_version = resources_json['apiVersion']
self.base_path = resources_json['basePath']
apis_json = resources_json['apis']
self.apis = [
ResourceApi().load(j, processor, context) for j in apis_json]
return self
def validate_required_fields(json, required_fields, context):
"""Checks a JSON object for a set of required fields.
If any required field is missing, a SwaggerError is raised.
@param json: JSON object to check.
@param required_fields: List of required fields.
@param context: Current context in the API.
"""
missing_fields = [f for f in required_fields if not f in json]
if missing_fields:
raise SwaggerError(
"Missing fields: %s" % ', '.join(missing_fields), context)
def add_context(context, json, id_field):
"""Returns a new context with a new item added to it.
@param context: Old context.
@param json: Current JSON object.
@param id_field: Field identifying this object.
@return New context with additional item.
"""
if not id_field in json:
raise SwaggerError("Missing id_field: %s" % id_field, context)
return context + ['%s=%s' % (id_field, str(json[id_field]))]
|