Merge pull request #3 from ekonstantinidis/get-all-urls

ekonstantinidis · ekonstantinidis · commit 55770e9e4be1 · 2015-12-12T13:59:00.000Z
List all the urls/views
diff --git a/README.md b/README.md
@@ -34,5 +34,5 @@ Finally include the `drfdocs` urls in your `urls.py`:
 
     urlpatterns = [
         ...
-        url(r'^docs/', include('drfdocs.urls', namespace='drfdocs')),
+        url(r'^docs/', include('drfdocs.urls', app_name='drfdocs', namespace='drfdocs')),
     ]
diff --git a/drfdocs/api_docs.py b/drfdocs/api_docs.py
@@ -0,0 +1,22 @@
+from django.conf import settings
+from django.core.urlresolvers import RegexURLResolver, RegexURLPattern
+
+
+class ApiDocumentation(object):
+    excluded_apps = ["admin", "drfdocs"]
+    excluded_endpoints = ["serve"]
+    root_urlconf = __import__(settings.ROOT_URLCONF)
+
+    def __init__(self):
+        self.view_names = []
+        self.get_all_view_names(self.root_urlconf.urls.urlpatterns)
+
+    def get_all_view_names(self, urlpatterns):
+        for pattern in urlpatterns:
+            if isinstance(pattern, RegexURLResolver) and (pattern.app_name not in self.excluded_apps):
+                self.get_all_view_names(pattern.url_patterns)
+            elif isinstance(pattern, RegexURLPattern) and (pattern.callback.__name__ not in self.excluded_endpoints):
+                self.view_names.append(pattern.callback.__name__)
+
+    def get_views(self):
+        return self.view_names
diff --git a/drfdocs/api_endpoint.py b/drfdocs/api_endpoint.py
diff --git a/drfdocs/templates/drfdocs/base.html b/drfdocs/templates/drfdocs/base.html
@@ -7,5 +7,7 @@
   <body>
     <h1>Django Rest Frameworks Docs</h1>
 
+    {% block content %}{% endblock %}
+
   </body>
 </html>
diff --git a/drfdocs/templates/drfdocs/home.html b/drfdocs/templates/drfdocs/home.html
@@ -1 +1,9 @@
 {% extends "drfdocs/base.html" %}
+
+{% block content %}
+  <ul>
+  {% for view in views %}
+    <li>{{ view }}</li>
+  {% endfor %}
+  </ul>
+{% endblock %}
diff --git a/drfdocs/views.py b/drfdocs/views.py
@@ -1,4 +1,5 @@
 from django.views.generic.base import TemplateView
+from drfdocs.api_docs import ApiDocumentation
 
 
 class DRFDocsView(TemplateView):
@@ -7,5 +8,6 @@ class DRFDocsView(TemplateView):
 
     def get_context_data(self, **kwargs):
         context = super(DRFDocsView, self).get_context_data(**kwargs)
-        context['example'] = True
+        docs = ApiDocumentation()
+        context['views'] = docs.get_views()
         return context

Original file line number	Diff line number	Diff line change
@@ -34,5 +34,5 @@ Finally include the `drfdocs` urls in your `urls.py`:
`34`	`34`
`35`	`35`	`urlpatterns = [`
`36`	`36`	`...`
`37`		`- url(r'^docs/', include('drfdocs.urls', namespace='drfdocs')),`
	`37`	`+ url(r'^docs/', include('drfdocs.urls', app_name='drfdocs', namespace='drfdocs')),`
`38`	`38`	`]`