Merge pull request #5 from edx/clintonb/drf-swagger

Added support for Swagger API documentation

course_discovery/settings/base.py

@@ -28,6 +28,7 @@ INSTALLED_APPS = (
 
 THIRD_PARTY_APPS = (
     'rest_framework',
+    'rest_framework_swagger',
     'social.apps.django_app.default',
     'waffle',
 )
@@ -117,6 +118,9 @@ TEMPLATES = [
     {
         'BACKEND': 'django.template.backends.django.DjangoTemplates',
         'APP_DIRS': True,
+        'DIRS': (
+            root('templates'),
+        ),
         'OPTIONS': {
             'context_processors': (
                 'django.contrib.auth.context_processors.auth',
@@ -222,3 +226,14 @@ LOGGING = {
         },
     }
 }
+
+
+REST_FRAMEWORK = {
+    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination',
+    'VIEW_DESCRIPTION_FUNCTION': 'rest_framework_swagger.views.get_restructuredtext'
+}
+
+SWAGGER_SETTINGS = {
+    'api_version': 'v1',
+    'doc_expansion': 'list',
+}

course_discovery/static/css/edx-swagger.css

+body {
+    margin: 0;
+}
+
+#header {
+    background-color: #fcfcfc;
+    border-bottom: 4px solid #0079bc;
+    color: #999999;
+}
+
+#django-rest-swagger {
+    background-color: white;
+    color: #999999;
+}
+
+#django-rest-swagger a {
+    color: inherit;
+}

course_discovery/templates/rest_framework_swagger/index.html

+{% extends 'rest_framework_swagger/base.html' %}
+
+{% load staticfiles %}
+
+{% block style %}
+    {{ block.super }}
+    <link href='{% static "css/edx-swagger.css" %}' media='screen' rel='stylesheet' type='text/css'/>
+{% endblock %}
+
+
+{% block branding %}
+    <span id="api-name">edX Course Discovery API</span>
+{% endblock %}
+
+{% block api_selector %}
+{% endblock %}

course_discovery/urls.py

@@ -34,6 +34,7 @@ urlpatterns = [
     url(r'^admin/', include(admin.site.urls)),
     url(r'^api/', include('course_discovery.apps.api.urls', namespace='api')),
     url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework')),
+    url(r'^api-docs/', include('rest_framework_swagger.urls')),
     url(r'^auto_auth/$', core_views.AutoAuth.as_view(), name='auto_auth'),
     url(r'^health/$', core_views.health, name='health'),
     url(r'^login/$', login, name='login'),
@@ -41,6 +42,7 @@ urlpatterns = [
     url('', include('social.apps.django_app.urls', namespace='social')),
 ]
 
+
 if settings.DEBUG and os.environ.get('ENABLE_DJANGO_TOOLBAR', False):  # pragma: no cover
     import debug_toolbar  # pylint: disable=import-error
     urlpatterns.append(url(r'^__debug__/', include(debug_toolbar.urls)))

requirements/base.txt

@@ -2,5 +2,6 @@ django == 1.8.7
 django-extensions == 1.5.9
 django-waffle == 0.11
 djangorestframework == 3.3.1
+django-rest-swagger==0.3.4
 edx-auth-backends == 0.1.3
 pytz == 2015.7