Merge pull request #122 from sctjgz/tjgz_swagger_impove

add one feature and fix some bugs

Author: gusibi

swagger_py_codegen/command.py

@@ -1,12 +1,15 @@
 from __future__ import absolute_import
-from os import path
+from os import path, listdir
 import codecs
+
+from swagger_py_codegen.jsonschema import Schema
+
 try:
     import simplejson as json
 except ImportError:
     import json
 from os import makedirs
-from os.path import join, exists, dirname
+from os.path import join, exists, dirname, isdir
 
 import six
 import yaml
@@ -29,8 +32,7 @@ def get_ref_filepath(filename, ref_file):
     return ref_file
 
 
-def spec_load(filename):
-    spec_data = {}
+def get_loader(filename):
     if filename.endswith('.json'):
         loader = json.load
     elif filename.endswith('.yml') or filename.endswith('.yaml'):
@@ -43,20 +45,67 @@ def spec_load(filename):
                 loader = json.load
             else:
                 loader = yaml.load
+    return loader
+
+
+def load_file(filename, spec_data):
+    loader = get_loader(filename)
     with codecs.open(filename, 'r', 'utf-8') as f:
         data = loader(f)
+        # modify_spec_data(spec_data, data)
         spec_data.update(data)
         for field, values in six.iteritems(data):
             if field not in ['definitions', 'parameters', 'paths']:
                 continue
             if not isinstance(values, dict):
                 continue
             for _field, value in six.iteritems(values):
+                # _field is the endpoint for paths when the api of paths contains $ref
                 if _field == '$ref' and value.endswith('.yml'):
                     _filepath = get_ref_filepath(filename, value)
                     field_data = spec_load(_filepath)
+                    # modify_spec_data(field, spec_data, field_data)
                     spec_data[field] = field_data
-        return spec_data
+                elif '$ref' in value:
+                    v = value.pop('$ref', '')
+                    if not v:
+                        continue
+                    _filepath = get_ref_filepath(filename, v)
+                    field_data = spec_load(_filepath)
+                    modify_spec_data(field, spec_data, field_data)
+                    # spec_data[field][_field] = field_data.values()
+
+
+def dump_file(filename, data):
+    if not filename.endswith('.yml'):
+        return None
+    if not exists(filename):
+        dirs = filename.rsplit('/', 1)[0]
+        # dirs, fn = '/'.join(paths[:-1]), paths[-1]
+        if not exists(dirs):
+            makedirs(dirs)
+    with codecs.open(filename, 'w', 'utf-8') as f:
+        yaml.dump(data, f, default_flow_style=False, allow_unicode=True)
+
+
+def modify_spec_data(field, spec_data, data):
+    if not isinstance(spec_data, dict) or not isinstance(data, dict):
+        return None
+    for k, v in data.items():
+        if k in spec_data[field]:
+            spec_data[field][k].update(v)
+        else:
+            spec_data[field][k] = v
+
+
+def spec_load(filename):
+    spec_data = {}
+    files = listdir(filename) if isdir(filename) else [filename]
+    for f in files:
+        if f != filename:
+            f = filename + '/' + f
+        load_file(f, spec_data)
+    return spec_data
 
 
 def write(dist, content):
@@ -124,6 +173,7 @@ def generate(destination, swagger_doc, force=False, package=None,
             click.echo("Validation passed")
         except ValidationError as e:
             raise click.ClickException(str(e))
+    #print 'data             ',data
     swagger = Swagger(data)
     if templates == 'tornado':
         generator = TornadoGenerator(swagger)

swagger_py_codegen/flask.py

@@ -10,59 +10,50 @@
 
 
 class Router(Code):
-
     template = 'flask/routers.tpl'
     dest_template = '%(package)s/%(module)s/routes.py'
     override = True
 
 
 class View(Code):
-
     template = 'flask/view.tpl'
     dest_template = '%(package)s/%(module)s/api/%(view)s.py'
     override = False
 
 
 class Specification(Code):
-
     template = 'flask/specification.tpl'
     dest_template = '%(package)s/static/%(module)s/swagger.json'
     override = True
 
 
 class Validator(Code):
-
     template = 'flask/validators.tpl'
     dest_template = '%(package)s/%(module)s/validators.py'
     override = True
 
 
 class Api(Code):
-
     template = 'flask/api.tpl'
     dest_template = '%(package)s/%(module)s/api/__init__.py'
 
 
 class Blueprint(Code):
-
     template = 'flask/blueprint.tpl'
     dest_template = '%(package)s/%(module)s/__init__.py'
 
 
 class App(Code):
-
     template = 'flask/app.tpl'
     dest_template = '%(package)s/__init__.py'
 
 
 class Requirements(Code):
-
     template = 'flask/requirements.tpl'
     dest_template = 'requirements.txt'
 
 
 class UIIndex(Code):
-
     template = 'ui/index.html'
     dest_template = '%(package)s/static/swagger-ui/index.html'
 
@@ -86,13 +77,14 @@ def _type(parameters):
             if t in types:
                 yield '<%s>' % p['name'], '<%s:%s>' % (types[t], p['name'])
 
-    for old, new in _type(node.get('parameters', [])):
-        url = url.replace(old, new)
+    for method, param in six.iteritems(node):
+        for old, new in _type(param.get('parameters', [])):
+            url = url.replace(old, new)
 
-    for k in SUPPORT_METHODS:
-        if k in node:
-            for old, new in _type(node[k].get('parameters', [])):
-                url = url.replace(old, new)
+        for k in SUPPORT_METHODS:
+            if k in param:
+                for old, new in _type(param[k].get('parameters', [])):
+                    url = url.replace(old, new)
 
     return url, params
 
@@ -126,7 +118,6 @@ def _location(swagger_location):
 
 
 class FlaskGenerator(CodeGenerator):
-
     dependencies = [SchemaGenerator]
 
     def __init__(self, swagger):

swagger_py_codegen/jsonschema.py

@@ -1,5 +1,7 @@
 from __future__ import absolute_import
 
+import copy
+
 import six
 from collections import OrderedDict
 from inspect import getsource
@@ -9,7 +11,6 @@
 
 
 class Schema(Code):
-
     template = 'jsonschema/schemas.tpl'
     dest_template = '%(package)s/%(module)s/schemas.py'
     override = True
@@ -27,8 +28,9 @@ def _parameters_to_schemas(params):
                 # schema is required `in` is `body`
                 yield location, param['schema']
                 continue
-
-            prop = param.copy()
+            # prop = param.copy()
+            # If the parameter is referanced more than once,it would be format only once.
+            prop = copy.deepcopy(param)
             prop.pop('in')
             if param.get('required'):
                 required.append(param['name'])
@@ -41,7 +43,6 @@ def _parameters_to_schemas(params):
 
 
 def build_data(swagger):
-
     validators = OrderedDict()  # (endpoint, method) = {'body': schema_name or schema, 'query': schema_name, ..}
     filters = OrderedDict()  # (endpoint, method) = {'200': {'schema':, 'headers':, 'examples':}, 'default': ..}
     scopes = OrderedDict()  # (endpoint, method) = [scope_a, scope_b]
@@ -56,19 +57,21 @@ def build_data(swagger):
 
         # methods
         for p, data in swagger.search(path + ('*',)):
+
             if p[-1] not in ['get', 'post', 'put', 'delete', 'patch', 'options', 'head']:
                 continue
             method_param = []
+
             try:
                 method_param = swagger.get(p + ('parameters',))
             except KeyError:
                 pass
 
             endpoint = p[1]  # p: ('paths', '/some/path', 'method')
             method = p[-1].upper()
-
             # parameters as schema
             validator = dict(_parameters_to_schemas(path_param + method_param))
+            #print 'parameters:::::::::::::', path_param, endpoint, method, validator, method_param
             if validator:
                 validators[(endpoint, method)] = validator
 
@@ -88,9 +91,9 @@ def build_data(swagger):
             for security in data.get('security', []):
                 scopes[(endpoint, method)] = list(security.values()).pop()
                 break
-
     data = dict(
-        definitions={'definitions':swagger.origin_data.get('definitions', {})},
+        definitions={'definitions': swagger.origin_data.get('definitions', {}),
+                     'parameters': swagger.origin_data.get('parameters', {})},
         validators=validators,
         filters=filters,
         scopes=scopes,
@@ -194,7 +197,7 @@ def _normalize_dict(schema, data):
 
             # get value
             value, has_key = data.get_check(key)
-            if has_key:
+            if has_key or '$ref' in _schema:
                 result[key] = _normalize(_schema, value)
             elif 'default' in _schema:
                 result[key] = _schema['default']
@@ -233,10 +236,10 @@ def _normalize_ref(schema, data):
             raise TypeError("resolver must be provided")
         ref = schema.get(u"$ref")
         scope, resolved = resolver.resolve(ref)
+        if resolved.get('nullable', False) and not data:
+            return {}
         return _normalize(resolved, data)
 
-
-
     def _normalize(schema, data):
         if schema is True or schema == {}:
             return data

swagger_py_codegen/templates/flask/validators.tpl

@@ -61,6 +61,13 @@ class FlaskValidatorAdaptor(object):
         for k, values in obj.lists():
             prop = self.validator.schema['properties'].get(k, {})
             type_ = prop.get('type')
+            if type_ is None and '$ref' in prop:
+                ref = prop.get('$ref')
+                if not ref:
+                    continue
+                type_ = self.validator.resolver.resolve(prop.get('$ref'))[1].get('type')
+                if not type_:
+                    continue
             fun = convert_funs.get(type_, lambda v: v[0])
             if type_ == 'array':
                 item_type = prop.get('items', {}).get('type')

tests/test_flask.py

@@ -8,22 +8,24 @@
     FlaskGenerator
 )
 
+
 def test_swagger_to_flask_url():
     cases = [
         {
             'url': '/users/{id}',
             'data': {
-                'parameters': [{
-                    'name': 'id',
-                    'in': 'path',
-                    'type': 'integer'
-                }],
                 'get': {
                     'parameters': [{
                         'name': 'limit',
                         'in': 'query',
                         'type': 'integer'
-                    }]
+                    },
+                        {
+                            'name': 'id',
+                            'in': 'path',
+                            'type': 'integer'
+                        }
+                    ]
                 },
                 'post': {
                     'parameters': [{
@@ -34,7 +36,13 @@ def test_swagger_to_flask_url():
                                 'name': {'type': 'string'}
                             }
                         }
-                    }]
+                    },
+                        {
+                            'name': 'id',
+                            'in': 'path',
+                            'type': 'integer'
+                        }
+                    ]
                 }
             },
             'expect': (
@@ -58,13 +66,12 @@ def test_swagger_to_flask_url():
                         'name': 'price',
                         'in': 'path',
                         'type': 'float'
+                    }, {
+                        'name': 'category',
+                        'in': 'path',
+                        'type': 'integer'
                     }]
                 },
-                'parameters': [{
-                    'name': 'category',
-                    'in': 'path',
-                    'type': 'integer'
-                }]
             },
             'expect': (
                 '/goods/categories/<int:category>/price-large-than/<float:price>/order-by/<order>',
@@ -81,7 +88,8 @@ def test_swagger_to_flask_url():
         }
     ]
     for case in cases:
-        assert _swagger_to_flask_url(case['url'], case['data']) == case['expect']
+        a = _swagger_to_flask_url(case['url'], case['data'])
+        assert a == case['expect']
 
 
 def test_path_to_endpoint():
@@ -121,7 +129,6 @@ def test_process_data():
                 'get': {},
                 'put': {},
                 'head': {},
-                'parameters': []
             },
             '/posts/{post_id}': {
                 'get': {