Merge pull request #5 from ekonstantinidis/allowed-methods

Allowed methods & Serializer Fields

Author: ekonstantinidis

drfdocs/api_endpoint.py

@@ -5,12 +5,28 @@ class ApiEndpoint(object):
 
     def __init__(self, pattern, parent_pattern=None):
         self.pattern = pattern
+        self.callback = pattern.callback
         self.name = pattern.name
-        self.path = self._get_path(parent_pattern)
+        self.name_parent = simplify_regex(parent_pattern.regex.pattern).replace('/', '') if parent_pattern else None
+        self.path = self.__get_path__(parent_pattern)
+        self.allowed_methods = self.__get_allowed_methods__()
         self.view_name = pattern.callback.__name__
+        self.fields = self.__get_serializer_fields__()
 
-    def _get_path(self, parent_pattern):
+    def __get_path__(self, parent_pattern):
         if parent_pattern:
-            parent_path = simplify_regex(parent_pattern.regex.pattern)[:-1]
-            return "{0}{1}".format(parent_path, simplify_regex(self.pattern.regex.pattern))
+            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):
+        return [m.upper() for m in self.callback.cls.http_method_names if hasattr(self.callback.cls, m)]
+
+    def __get_serializer_fields__(self):
+        fields = []
+
+        if hasattr(self.callback.cls, 'serializer_class') and hasattr(self.callback.cls.serializer_class, 'get_fields'):
+            serializer = self.callback.cls.serializer_class
+            if hasattr(serializer, 'get_fields'):
+                fields = [{"name": key, "type": str(value.__class__.__name__)} for key, value in serializer().get_fields().items()]
+
+        return fields

drfdocs/static/css/style.css

@@ -22,6 +22,12 @@ body {
 
 .endpoint .title {
   font-family: Menlo,Monaco,Consolas,"Courier New",monospace;
+  word-wrap: break-word;
+}
+
+.endpoint .methods .method {
+  border: 1px solid #2c3e50;
+  padding: 3px 8px;
 }
 
 /* @end Endpoint */

drfdocs/templates/drfdocs/home.html

@@ -1,13 +1,38 @@
 {% extends "drfdocs/base.html" %}
 
 {% block content %}
-  <h2>API Endpoints</h2>
-
-  {% for endpoint in endpoints %}
-    <div class="endpoint">
-      <h3 class="title">{{ endpoint.path }}</h3>
-      <p>View Name: {{ endpoint.view_name }}</p>
-      <p>URL Name: {{ endpoint.name }}</p>
-    </div>
+
+  <h1>API Endpoints</h1>
+  {% regroup endpoints by name_parent as endpoints_grouped %}
+
+  {% for group in endpoints_grouped %}
+    <h1>{{group.grouper}}</h1>
+
+    {% for endpoint in group.list %}
+      <div class="endpoint">
+        <h4 class="title">{{ endpoint.path }}</h4>
+
+        <ul class="list-inline methods">
+          {% for method in endpoint.allowed_methods %}
+            <li class="method">{{ method }}</li>
+          {% endfor %}
+        </ul>
+
+        <p>View Name: {{ endpoint.view_name }}</p>
+        <p>URL Name: {{ endpoint.name }}</p>
+
+        {% if endpoint.fields %}
+        <p>Fields:</p>
+          <ul class="list fields">
+          {% for field in endpoint.fields %}
+            <li class="field">{{ field.name }}: {{ field.type }}</li>
+          {% endfor %}
+          </ul>
+        {% endif %}
+
+      </div>
+    {% endfor %}
+
   {% endfor %}
+
 {% endblock %}