API docs

lovelydinosaur · lovelydinosaur · commit c501f23eabd9 · 2017-01-18T14:52:58.000Z
diff --git a/snippets/models.py b/snippets/models.py
@@ -12,15 +12,17 @@
 
 class Snippet(models.Model):
     created = models.DateTimeField(auto_now_add=True)
-    title = models.CharField(max_length=100, blank=True, default='')
-    code = models.TextField()
-    linenos = models.BooleanField(default=False)
+    title = models.CharField(max_length=100, blank=True, default='', help_text='A descriptive title for the snippet.')
+    code = models.TextField(help_text='The code sample to highlight.')
+    linenos = models.BooleanField(default=False, verbose_name='Line numbers', help_text='`True` if line numbers should be included.')
     language = models.CharField(choices=LANGUAGE_CHOICES,
                                 default='python',
-                                max_length=100)
+                                max_length=100,
+                                help_text='Programming language.')
     style = models.CharField(choices=STYLE_CHOICES,
                              default='friendly',
-                             max_length=100)
+                             max_length=100,
+                             help_text='Highlighting style.')
     owner = models.ForeignKey('auth.User', related_name='snippets')
     highlighted = models.TextField()
 
diff --git a/snippets/views.py b/snippets/views.py
@@ -34,13 +34,16 @@ def highlight(self, request, *args, **kwargs):
 
     def perform_create(self, serializer):
         serializer.save(owner=self.request.user)
-    
+
 class UserViewSet(viewsets.ReadOnlyModelViewSet):
     """
-    This endpoint presents the users in the system.
+    list:
+
+    Return all the user instances.
+
+    retrieve:
 
-    As you can see, the collection of snippet instances owned by a user are
-    serialized using a hyperlinked representation.
+    Return the given user instance.
     """
     queryset = User.objects.all()
     serializer_class = UserSerializer
diff --git a/tutorial/settings.py b/tutorial/settings.py
@@ -2,7 +2,7 @@
 
 DEBUG = True
 TEMPLATE_DEBUG = DEBUG
-
+ALLOWED_HOSTS = ['*']
 ADMINS = (
     # ('Your Name', 'your_email@example.com'),
 )
diff --git a/tutorial/urls.py b/tutorial/urls.py
@@ -1,12 +1,16 @@
 from snippets import views
 from django.conf.urls import patterns, url, include
+from rest_framework.documentation import get_docs_view
 from rest_framework.routers import DefaultRouter
 
+
 router = DefaultRouter()
 router.register(r'snippets', views.SnippetViewSet)
 router.register(r'users', views.UserViewSet)
 
+
 urlpatterns = patterns('',
     url(r'^', include(router.urls)),
-    url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
+    url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework')),
+    url(r'^docs/', get_docs_view(title='Pastebin API')),
 )

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`DEBUG = True`
`4`	`4`	`TEMPLATE_DEBUG = DEBUG`
`5`		`-`
	`5`	`+ALLOWED_HOSTS = ['*']`
`6`	`6`	`ADMINS = (`
`7`	`7`	`# ('Your Name', 'your_email@example.com'),`
`8`	`8`	`)`