Merge pull request #11 from ekonstantinidis/required-fields

Required Fields

Author: ekonstantinidis

README.md

@@ -3,21 +3,23 @@
 Document Web APIs made with Django Rest Framework.
 
 
-### Prerequisites
+### Supports
 
-  - Python (3.3, 3.4, 3.5)
-  - Django (1.8, 1.9)
+  - Python (2.7, 3.3, 3.4, 3.5)
+  - Django (1.7, 1.8, 1.9)
   - Django Rest Framework (3+)
 
 
-### Development
+### Development & Demo Project
+If you are looking to develop this package with one of your own django projects:
 
     pyvenv env
     env/bin/pip install -r requirements.txt
-
-    # To test within another django project
     pip install -e ~/Projects/drf-docs/
 
+If you want to use the demo app to work on this package:
+Included in this repo you can find the demo project(at `/demo`). It is a project with *Django* & *Django Rest Framework* that will allow you to work with this project. For more information on how you can set it up please check the [README.md](demo/README.md) of the demo project.
+
 ### Installation
 
 Install using pip:
@@ -38,17 +40,17 @@ Finally include the `rest_framework_docs` urls in your `urls.py`:
         url(r'^docs/', include('rest_framework_docs.urls')),
     ]
 
-### Development & Demo Project
-Included in this repo you can find the demo project(at `/demo`). It is a project with *Django* & *Django Rest Framework* that will allow you to work with this project. For more information on how you can set it up please readme the [README.md](demo/README.md) of the demo project.
 
 ### Settings
 
     REST_FRAMEWORK_DOCS = {
         'HIDDEN': True  # Default: False
     }
 
+
 ### Roadmap
 
+  - [ ] Creade demo app
   - [ ] Support Python 2 & Python 3
   - [ ] Support DRF 3+
   - [ ] Open Pull Request to include in DRF

demo/project/organisations/models.py

@@ -10,7 +10,7 @@ class Organisation(models.Model):
     modified = models.DateTimeField(auto_now=True)
 
     name = models.CharField(unique=True, max_length=100)
-    slug = models.SlugField(unique=True)
+    slug = models.SlugField(unique=True, null=True, blank=True)
     members = models.ManyToManyField(User, through='Membership', through_fields=('organisation', 'user'))
 
     is_active = models.BooleanField(default=False)

rest_framework_docs/api_endpoint.py

@@ -27,6 +27,13 @@ def __get_serializer_fields__(self):
         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()]
+                fields = [{
+                    "name": key,
+                    "type": str(field.__class__.__name__),
+                    "required": field.required
+                } for key, field in serializer().get_fields().items()]
+
+                # FIXME:
+                # Show more attibutes of `field`?
 
         return fields

rest_framework_docs/static/less/style.less

@@ -30,6 +30,11 @@ body {
   text-align: center;
 }
 
+.label-required {
+  padding: 2px 5px;
+  margin-left: 5px;
+}
+
 /* @end Misc */
 
 

rest_framework_docs/templates/rest_framework_docs/home.html

@@ -6,7 +6,7 @@
   <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Jump To <span class="caret"></span></a>
   <ul class="dropdown-menu">
     {% for group in endpoints_grouped %}
-      <li><a href="#{{ group.grouper|lower }}">{{ group.grouper }}</a></li>
+      <li><a href="#{{ group.grouper|lower }}-nav">{{ group.grouper }}</a></li>
     {% endfor %}
   </ul>
 </li>
@@ -20,7 +20,7 @@
   {% if endpoints_grouped %}
   {% for group in endpoints_grouped %}
 
-    <h1 id="{{ group.grouper|lower }}">{{group.grouper}}</h1>
+    <h1 id="{{ group.grouper|lower }}-nav">{{group.grouper}}</h1>
 
     <div class="panel-group" role="tablist">
 
@@ -52,7 +52,7 @@ <h4 class="panel-title title">
             <p>Fields:</p>
               <ul class="list fields">
               {% for field in endpoint.fields %}
-                <li class="field">{{ field.name }}: {{ field.type }}</li>
+                <li class="field">{{ field.name }}: {{ field.type }} {% if field.required %}<span class="label label-primary label-required" title="Required">R</span>{% endif %}</li>
               {% endfor %}
               </ul>
             {% else %}