Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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')),
]
22 changes: 22 additions & 0 deletions drfdocs/api_docs.py
Original file line number Diff line number Diff line change
@@ -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
Empty file added drfdocs/api_endpoint.py
Empty file.
2 changes: 2 additions & 0 deletions drfdocs/templates/drfdocs/base.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,7 @@
<body>
<h1>Django Rest Frameworks Docs</h1>

{% block content %}{% endblock %}

</body>
</html>
8 changes: 8 additions & 0 deletions drfdocs/templates/drfdocs/home.html
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
{% extends "drfdocs/base.html" %}

{% block content %}
<ul>
{% for view in views %}
<li>{{ view }}</li>
{% endfor %}
</ul>
{% endblock %}
4 changes: 3 additions & 1 deletion drfdocs/views.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
from django.views.generic.base import TemplateView
from drfdocs.api_docs import ApiDocumentation


class DRFDocsView(TemplateView):
Expand All @@ -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