diff --git a/docs/installation.md b/docs/installation.md index 1e7805c..f0a4f68 100755 --- a/docs/installation.md +++ b/docs/installation.md @@ -22,4 +22,4 @@ Finally include the `rest_framework_docs` urls in your `urls.py`: url(r'^docs/', include('rest_framework_docs.urls')), ] -You can now visit [http://0.0.0.0:/8000/docs/](http://0.0.0.0:8000/docs/) to view your Web API's docs. +You can now visit [http://0.0.0.0:8000/docs/](http://0.0.0.0:8000/docs/) to view your Web API's docs. diff --git a/rest_framework_docs/api_docs.py b/rest_framework_docs/api_docs.py index d22dd4c..d14fae4 100644 --- a/rest_framework_docs/api_docs.py +++ b/rest_framework_docs/api_docs.py @@ -21,13 +21,13 @@ def __init__(self, drf_router=None): else: self.get_all_view_names(root_urlconf.urlpatterns) - def get_all_view_names(self, urlpatterns, parent_pattern=None): + def get_all_view_names(self, urlpatterns, parent_regex=''): for pattern in urlpatterns: if isinstance(pattern, RegexURLResolver): - parent_pattern = None if pattern._regex == "^" else pattern - self.get_all_view_names(urlpatterns=pattern.url_patterns, parent_pattern=parent_pattern) + regex = '' if pattern._regex == "^" else pattern._regex + self.get_all_view_names(urlpatterns=pattern.url_patterns, parent_regex=parent_regex + regex) elif isinstance(pattern, RegexURLPattern) and self._is_drf_view(pattern) and not self._is_format_endpoint(pattern): - api_endpoint = ApiEndpoint(pattern, parent_pattern, self.drf_router) + api_endpoint = ApiEndpoint(pattern, parent_regex, self.drf_router) self.endpoints.append(api_endpoint) def _is_drf_view(self, pattern): diff --git a/rest_framework_docs/api_endpoint.py b/rest_framework_docs/api_endpoint.py index 89a33f8..953f9a0 100644 --- a/rest_framework_docs/api_endpoint.py +++ b/rest_framework_docs/api_endpoint.py @@ -1,20 +1,28 @@ import json import inspect + from django.contrib.admindocs.views import simplify_regex from django.utils.encoding import force_str + +from rest_framework.viewsets import ModelViewSet from rest_framework.serializers import BaseSerializer +VIEWSET_METHODS = { + 'List': ['get', 'post'], + 'Instance': ['get', 'put', 'patch', 'delete'], +} + class ApiEndpoint(object): - def __init__(self, pattern, parent_pattern=None, drf_router=None): + def __init__(self, pattern, parent_regex=None, drf_router=None): self.drf_router = drf_router self.pattern = pattern self.callback = pattern.callback # self.name = pattern.name self.docstring = self.__get_docstring__() - self.name_parent = simplify_regex(parent_pattern.regex.pattern).strip('/') if parent_pattern else None - self.path = self.__get_path__(parent_pattern) + self.name_parent = simplify_regex(parent_regex).strip('/') if parent_regex else None + self.path = self.__get_path__(parent_regex) self.allowed_methods = self.__get_allowed_methods__() # self.view_name = pattern.callback.__name__ self.errors = None @@ -26,13 +34,19 @@ def __init__(self, pattern, parent_pattern=None, drf_router=None): self.permissions = self.__get_permissions_class__() - def __get_path__(self, parent_pattern): - if parent_pattern: + def __get_path__(self, parent_regex): + if parent_regex: return "/{0}{1}".format(self.name_parent, simplify_regex(self.pattern.regex.pattern)) return simplify_regex(self.pattern.regex.pattern) - def __get_allowed_methods__(self): + def is_method_allowed(self, callback_cls, method_name): + has_attr = hasattr(callback_cls, method_name) + viewset_method = (issubclass(callback_cls, ModelViewSet) and + method_name in VIEWSET_METHODS.get(self.callback.suffix, [])) + + return has_attr or viewset_method + def __get_allowed_methods__(self): viewset_methods = [] if self.drf_router: for prefix, viewset, basename in self.drf_router.registry: @@ -57,14 +71,18 @@ def __get_allowed_methods__(self): ) if self.pattern.regex.pattern == regex: funcs, viewset_methods = zip( - *[(mapping[m], m.upper()) for m in self.callback.cls.http_method_names if m in mapping] + *[(mapping[m], m.upper()) + for m in self.callback.cls.http_method_names + if m in mapping] ) viewset_methods = list(viewset_methods) if len(set(funcs)) == 1: self.docstring = inspect.getdoc(getattr(self.callback.cls, funcs[0])) - view_methods = [force_str(m).upper() for m in self.callback.cls.http_method_names if hasattr(self.callback.cls, m)] - return viewset_methods + view_methods + view_methods = [force_str(m).upper() + for m in self.callback.cls.http_method_names + if self.is_method_allowed(self.callback.cls, m)] + return sorted(viewset_methods + view_methods) def __get_docstring__(self): return inspect.getdoc(self.callback) diff --git a/rest_framework_docs/templates/rest_framework_docs/home.html b/rest_framework_docs/templates/rest_framework_docs/home.html index 235a6ee..e13e5a5 100644 --- a/rest_framework_docs/templates/rest_framework_docs/home.html +++ b/rest_framework_docs/templates/rest_framework_docs/home.html @@ -1,4 +1,5 @@ {% extends "rest_framework_docs/docs.html" %} +{% load drfdocs_filters %} {% block apps_menu %} {% regroup endpoints by name_parent as endpoints_grouped %} @@ -56,7 +57,7 @@
{{ endpoint.docstring }}
+{{ endpoint.docstring|markdown }}
{% endif %} {% if endpoint.errors %} diff --git a/rest_framework_docs/templatetags/__init__.py b/rest_framework_docs/templatetags/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/rest_framework_docs/templatetags/drfdocs_filters.py b/rest_framework_docs/templatetags/drfdocs_filters.py new file mode 100644 index 0000000..4d1642a --- /dev/null +++ b/rest_framework_docs/templatetags/drfdocs_filters.py @@ -0,0 +1,12 @@ +from django import template +from django.template.defaultfilters import stringfilter +from rest_framework.utils.formatting import markup_description + + +register = template.Library() + + +@register.filter(name='markdown') +@stringfilter +def markdown(value): + return markup_description(value) diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..f3b0a13 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[bdist_rpm] +obsoletes = django-rest-framework-docs diff --git a/tests/tests.py b/tests/tests.py index 998faee..f94736c 100644 --- a/tests/tests.py +++ b/tests/tests.py @@ -21,7 +21,7 @@ def test_settings_module(self): def test_index_view_with_endpoints(self): """ - Should load the drf focs view with all the endpoints. + Should load the drf docs view with all the endpoints. NOTE: Views that do **not** inherit from DRF's "APIView" are not included. """ response = self.client.get(reverse('drfdocs')) @@ -31,7 +31,7 @@ def test_index_view_with_endpoints(self): # Test the login view self.assertEqual(response.context["endpoints"][0].name_parent, "accounts") - self.assertEqual(response.context["endpoints"][0].allowed_methods, ['POST', 'OPTIONS']) + self.assertEqual(set(response.context["endpoints"][0].allowed_methods), set(['OPTIONS', 'POST'])) self.assertEqual(response.context["endpoints"][0].path, "/accounts/login/") self.assertEqual(response.context["endpoints"][0].docstring, "A view that allows users to login providing their username and password.") self.assertEqual(len(response.context["endpoints"][0].fields), 2) @@ -39,7 +39,7 @@ def test_index_view_with_endpoints(self): self.assertTrue(response.context["endpoints"][0].fields[0]["required"]) self.assertEqual(response.context["endpoints"][1].name_parent, "accounts") - self.assertEqual(response.context["endpoints"][1].allowed_methods, ['POST', 'OPTIONS']) + self.assertEqual(set(response.context["endpoints"][1].allowed_methods), set(['POST', 'OPTIONS'])) self.assertEqual(response.context["endpoints"][1].path, "/accounts/login2/") self.assertEqual(response.context["endpoints"][1].docstring, "A view that allows users to login providing their username and password. Without serializer_class") self.assertEqual(len(response.context["endpoints"][1].fields), 2) @@ -77,7 +77,7 @@ def test_model_viewset(self): self.assertEqual(response.context['endpoints'][6].fields[2]['to_many_relation'], True) self.assertEqual(response.context["endpoints"][11].path, '/organisation-model-viewsets/') self.assertEqual(response.context["endpoints"][12].path, '/organisation-model-viewsets/