Merge pull request #174 from peterjwest/featured/recursive-model

Add support for recursive models

Author: j5awry

flask_restx/swagger.py

@@ -657,6 +657,8 @@ def register_model(self, model):
         if name not in self.api.models:
             raise ValueError("Model {0} not registered".format(name))
         specs = self.api.models[name]
+        if name in self._registered_models:
+            return ref(model)
         self._registered_models[name] = specs
         if isinstance(specs, ModelBase):
             for parent in specs.__parents__:

tests/test_swagger.py

@@ -2057,6 +2057,27 @@ def get(self):
 
         client.get_specs(status=500)
 
+    def test_recursive_model(self, api, client):
+        fields = api.model('Person', {
+            'name': restx.fields.String,
+            'age': restx.fields.Integer,
+            'birthdate': restx.fields.DateTime,
+        })
+
+        fields["children"] = restx.fields.List(
+            restx.fields.Nested(fields),
+            default=[],
+        )
+
+        @api.route('/recursive-model/')
+        @api.doc(get={'model': fields})
+        class ModelAsDict(restx.Resource):
+            @api.marshal_with(fields)
+            def get(self):
+                return {}
+
+        client.get_specs(status=200)
+
     def test_specs_no_duplicate_response_keys(self, api, client):
         """
         This tests that the swagger.json document will not be written with duplicate object keys