Added Response code and message support (a partially fix for marcgibb…

…ons#37)
Tourmanage · Dec 24, 2013 · f510a83 · f510a83
1 parent 0d52a8c
commit f510a83
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -112,22 +112,28 @@ The parser handles the following:
 * Method implementation notes
 * Query parameters (user-defined)
 * Post parameters (user-defined)
-* serializer (user-defined)
-* deserializer (user-defined)
+* Serializer (user-defined)
+* Deserializer (user-defined)
+* Response code and message (user-defined)
 
 ```python
 class Countries(APIView):
     """
     This text is the description for this API
 
-    :Query:
+    :query:
       param1
           :required:
           A get parameter description
       param2 : int
           A integer get parameter description
 
     :serializer: .serializers.CountrySerializer
+
+    :response:
+      404 : Country ain't there
+      500
+        Please contact ... we have a problem
     """
 ```
 

diff --git a/rest_framework_swagger/docgenerator.py b/rest_framework_swagger/docgenerator.py
@@ -97,6 +97,18 @@ def generate_method_operation(self, introspector):
         parameters = introspector.get_parameters()
         if len(parameters) > 0:
             operation['parameters'] = parameters
+
+        responses = introspector.get_response_messages()
+        if isinstance(responses, dict) and len(responses) > 0:
+            messages = []
+            for code in responses:
+                description = responses[code]
+                messages.append({
+                    'code': code,
+                    'message': formatter(description)
+                })
+            operation['responseMessages'] = messages
+
         return operation
 
     def generate_model(self, serializer):

diff --git a/rest_framework_swagger/docparsers.py b/rest_framework_swagger/docparsers.py
@@ -63,7 +63,7 @@ def parse(self, doc):
         rtn['description'] = []
         variable_names = ['deserializer', 'serializer']
         # TODO allow for types array or object (or similar) within the lists
-        list_names = ['query', 'post']
+        list_names = ['query', 'post', 'response']
 
         lines = trim_docstring(doc).split('\n')
 
@@ -174,6 +174,11 @@ def _normalize(self, rtn, section_names):
             rtn['query'] = self._normalize_params(rtn['query'])
         if 'post' in rtn and rtn['post']:
             rtn['post'] = self._normalize_params(rtn['post'])
+
+        if 'response' in rtn and rtn['response']:
+            rtn['responses'] = self._convert_params_to_dict(rtn['response'])
+            del rtn['response']
+
         return rtn
 
     def _parse_variable(self, line):
@@ -194,4 +199,11 @@ def _normalize_params(self, params):
             if ('type' not in param or not param['type']) and \
                 ('dataType' not in param or not param['dataType']):
                 param['type'] = param['dataType'] = ""
-        return params
+        return params
+
+    def _convert_params_to_dict(self, params):
+        rtn = {}
+        for param in params:
+            desc = param['description'] if param['description'] != '' else param['type']
+            rtn[param['name']] = desc
+        return rtn
diff --git a/rest_framework_swagger/introspectors.py b/rest_framework_swagger/introspectors.py
@@ -177,6 +177,9 @@ def retrieve_docstring(self):
             return None
         return getattr(self.callback, method).__doc__
 
+    def get_response_messages(self):
+        return self.documentation['responses'] if 'responses' in self.documentation else None
+
     def get_parameters(self):
         """
         Returns parameters for an API. Parameters are a combination of HTTP

diff --git a/rest_framework_swagger/tests.py b/rest_framework_swagger/tests.py
@@ -420,6 +420,10 @@ def test_parse(self):
             :serializer: .serializer
             :deserializer: .deserializer
 
+            :response:
+                200
+                    Ok
+                404: Not found
             :unknown:
                 test
                     test
@@ -437,6 +441,10 @@ def test_parse(self):
             ],
             'serializer': '.serializer',
             'deserializer': '.deserializer',
+            'responses': {
+                '200': 'Ok',
+                '404': 'Not found'
+            }
         }
         self.assertDictEqual(expected, self.parser.parse(docstring))