Send back some actual info about the endpoint.

This is roughly the same as what is available in the HTML template.

Author: jwg4

flask_selfdoc/autodoc.py

@@ -199,13 +199,24 @@ def html(self, groups='all', template=None, **context):
     def json(self, groups='all'):
         """Return a json object with documentation for all the routes specified
         by the doc() method.
-        
+
         By specifiying the groups argument, only routes belonging to those groups
         will be returned.
         """
         autodoc = self.generate(groups=groups)
+
+        def endpoint_info(doc):
+            args = doc['args']
+            if args == ['None']:
+                args = []
+            return {
+                "args": [(arg, doc['defaults'][arg]) for arg in args],
+                "docstring": doc['docstring'],
+                "methods": sorted(list(doc['methods'])),
+                "rule": doc['rule']
+            }
         data = {
             'endpoints':
-                [ "doc" for doc in autodoc ]
+                [endpoint_info(doc) for doc in autodoc]
         }
         return jsonify(data)

tests/test_flask_get.py

@@ -36,3 +36,13 @@ def json_docs():
 
         data = json.loads(response.data)
         self.assertIn('endpoints', data)
+        self.assertEqual(len(data['endpoints']), 1)
+
+        endpoint = data['endpoints'][0]
+        expected = {
+            "args": [],
+            "docstring": "Returns a hello world message",
+            "methods": ["GET", "HEAD", "OPTIONS"],
+            "rule": "/"
+        }
+        self.assertEqual(endpoint, expected)